https://github.com/arjunsajeev/node-hn-api
A promise based wrapper for the Firebase Hacker News API
https://github.com/arjunsajeev/node-hn-api
hackernews hackernews-api node wrapper
Last synced: 5 months ago
JSON representation
A promise based wrapper for the Firebase Hacker News API
- Host: GitHub
- URL: https://github.com/arjunsajeev/node-hn-api
- Owner: arjunsajeev
- Created: 2017-08-27T15:53:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-05-17T16:19:57.000Z (8 months ago)
- Last Synced: 2025-07-20T18:08:22.940Z (6 months ago)
- Topics: hackernews, hackernews-api, node, wrapper
- Language: TypeScript
- Homepage:
- Size: 372 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-hn-api [](https://travis-ci.org/arjunsajeev/node-hn-api) [](https://www.npmjs.com/package/node-hn-api) [](http://makeapullrequest.com)
A promise based wrapper for the
[Firebase Hacker News API](https://github.com/HackerNews/API)
## Installation
```sh
npm i node-hn-api
```
## Usage
```js
const hn = require('node-hn-api');
hn.fetchTopStories(5)
.then((topStories) => {
//..
})
.catch((err) => {
console.error(err);
});
```
## API
### fetchItem(itemId) - Fetch Hacker News [Item](https://github.com/HackerNews/API) data
Returns a promise
### fetchUser(userId) - Fetch Hacker News [User](https://github.com/HackerNews/API#users) data
Returns a promise
### fetchTopStories([numberOfStories]) - Fetch Hacker News [Top Stories](https://github.com/HackerNews/API#new-top-and-best-stories) data
Returns a promise
#### numberOfStories - number
Number of records to fetch
### fetchNewStories([numberOfStories]) - Fetch Hacker News [New Stories](https://github.com/HackerNews/API#new-top-and-best-stories) data
Returns a promise
#### numberOfStories - number
Number of records to fetch
### fetchBestStories([numberOfStories]) - Fetch Hacker News [Best Stories](https://github.com/HackerNews/API#new-top-and-best-stories) data
Returns a promise
#### numberOfStories - number
Number of records to fetch
### fetchAskStories([numberOfStories]) - Fetch [Ask Hacker News Stories](https://github.com/HackerNews/API#ask-show-and-job-stories) data
Returns a promise
#### numberOfStories - number
Number of records to fetch
### fetchShowStories([numberOfStories]) - Fetch [Show Hacker News Stories](https://github.com/HackerNews/API#ask-show-and-job-stories) data
Returns a promise
#### numberOfStories - number
Number of records to fetch
### fetchJobStories([numberOfStories]) - Fetch Hacker News [Job Stories](https://github.com/HackerNews/API#ask-show-and-job-stories) data
Returns a promise
#### numberOfStories - number
Number of records to fetch