Wrapper around HNSearch REST API
node-hnsearch is a thin wrapper around the HNSearch REST API. Since node-hnsearch is such a thin wrapper, consulting the documentation provided by HNSearch is highly advised.
$ npm install hnsearch
var hnsearch = require'hnsearch';
Use for querying submissions, comments, and users, respectively, against HNSearch's search API.
query is the object containing the key-value pairs that the query string will be composed of.
cb is the callback function that will be called when the response from HNSearch is received. It should support a
(err, response) signature.
Details about the query fields and the
response object can be found on the HNSearch API website.
No tests yet! As soon as there are some though, you'll be able to run them as follows:
$ cd node-hnsearch$ npm test
Found a bug? Create an issue on GitHub.
For transparency and insight into the release cycle, releases will be numbered with the follow format:
And constructed with the following guidelines:
- Breaking backwards compatibility bumps the major
- New additions without breaking backwards compatibility bumps the minor
- Bug fixes and misc changes bump the patch
For more information on semantic versioning, please visit http://semver.org/.
Copyright (c) 2013 Jake Harding
Licensed under the MIT License.