yc-api

2.0.3 • Public • Published

What is it?

This is a wrapper module around the Hacker News API. You can filter the news in order to show you only the stories with a minimum score.

async/awaitg support

Tha last version of this library support async/await.

Installation

As simple as npm install yc-api

Usages

Import the module with const yc-api = require('yc-api').

get_top_stories_id()

This take the top stories (IDs) from YC and return them.

get_story(url)

Takes an url as argument and return a JSON object containing the story.

The returned object looks like this:

{
      "by" : "dhouston",
      "descendants" : 71,
      "id" : 8863,
      "kids" : [ 8952, 9224, 8917, 8884, 8887, 8943, 8869, 8958, 9005, 9671, 8940, 9067, 8908, 9055, 8865, 8881, 8872, 8873, 8955, 10403, 8903, 8928, 9125, 8998, 8901, 8902, 8907, 8894, 8878, 8870, 8980, 8934, 8876 ],
      "score" : 111,
      "time" : 1175714200,
      "title" : "My YC app: Dropbox - Throw away your USB drive",
      "type" : "story",
      "url" : "http://www.getdropbox.com/u/2/screencast.html"
  }

get_stories()

Return an array of JSON object containing the stories.

stories_with_score(score)

Same as get_stories but return into the object only the stories with the minimum score of score.

Example

stories_with_score(200).then(stories => console.log(stories));

Example

const YC = require("yc-api");
 
const api = new YC();
 
api.stories_with_score(500).then(stories => console.log(stories));
 
 
// using async
const stories = await api.stories_with_score(200);
console.log(stories)```

Readme

Keywords

none

Package Sidebar

Install

npm i yc-api

Weekly Downloads

0

Version

2.0.3

License

ISC

Unpacked Size

3.53 kB

Total Files

3

Last publish

Collaborators

  • gagginaspinnata