Giter Site home page Giter Site logo

superherodb-parser's Introduction

SuperheroDB Parser

Build Status Coverage Status

This project is only an example of how to create a parser/API based on web scrapping. Its only purpose is to show/learn a more functional/promise-friendly way of scrapping the web.

It retrieves basic information, if you need a complete profile of every superhero known, go to the original site SuperHeroDB.

Usage

  • Install the package
npm install superherodb-parser

Search for a superhero by name:

// search.js
'use strict';

const shdb = require('superherodb-parser');

const heroName = 'hulk';

shdb.search(heroName).then((res) => {
  console.log('Search result : ');
  console.log(JSON.stringify(res, null, 2));
});

Fetch a superhero by ID:

// fetch.js
'use strict';

const shdb = require('superherodb-parser');

const heroId = '/iron-man/10-85/';

shdb.fetch(heroId).then((res) => {
  console.log('Your hero stats: ');
  console.log(JSON.stringify(res, null, 2) );
});

TODO

  • Improve the ID fetch parameters
  • Add a group search
  • Add more examples
  • Create a CLI package

Disclaimer

This project is not affiliated with SuperHeroDB.com site. All the credits for a great site is theirs.

superherodb-parser's People

Contributors

guumaster avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.