npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hacker-news-api

v2.0.0

Published

Node.js library for Algolia's Hacker News API

Downloads

20

Readme

Node.js Hacker News API

A Node.js library for seamless integration with Algolia's kickass Hacker News API.

Installation

npm install hacker-news-api

Examples

Almost all methods are chainable, with flexible ordering. Methods are executed (as in HTTP requests are made) once a callback function is passed (not all methods accept a callback). Thus, this will always be the last method in the chain.

var hn = require('hacker-news-api');

// Get recent ask_hn posts, polls, and comments
hn.ask_hn().poll().comment().recent(function (error, data) {
  if (error) throw error;
  console.log(data);
});

// Get pg's top story and show_hn posts
hn.author('pg').story().show_hn().top(function (error, data) {
  if (error) throw error;
  console.log(data);
});

// Search for comments and storys containing 'js' before the past week
hn.comment().story().search('js').before('past_week', function (error, data) {
  if (error) throw error;
  console.log(data);
});

Chainable Methods

Tags (OR'ed)

These tags are logically OR'ed when chained.

  • ask_hn()
  • comment()
  • poll()
  • pollopt()
  • show_hn()
  • story()

Tags (AND'ed)

These tags are logically AND'ed when chained.

  • author(username)
  • story(id)

Filters

These methods take an optional callback function.

  • recent(cb)
  • top(cb)

Time

These methods take an optional callback function.

  • before(marker, cb)
  • since(marker, cb)

The following are valid inputs for the marker parameter:

  • 'past_24h'
  • 'past_week'
  • 'past_month'
  • 'forever'

Search

This method takes an optional callback function.

  • search(query, cb)

Settings

  • hitsPerPage(n)
    • n must be an integer and 1 <= n <= 1000
    • Default is 1000
    • This setting is persistant from one request another
  • page(n)
    • n must be an integer and 0 <= n

Non-chainable

By definition these methods are not chainable.

  • item(id, cb)
    • Get specific item
  • user(username, cb)
    • Get user profile

API Notes

Keep in mind that Algolia has a rate limit of 10,000 requests per hour from a single IP. Also, requests have a max of a 1000 hits (results). By default, hitsPerPage is to this max (it is configurable however). So for example, author().comment().since() called with past_month will return the first 1000 posts within the last month from the author (user) in question, but there could easily be more than that. You can check this via nbHits in the returned JSON, the total number of hits for the query.