Code Monkey home page Code Monkey logo

hn-ts's Introduction

hn-ts

Build status Coverage jsDocs.io Language npm bundle size npm License

A TypeScript client for the Hacker News API.

Features

  • Fully typed API and response data
  • Well documented and tested

API & Package Info

Install

Using npm:

npm i hn-ts

Using yarn:

yarn add hn-ts

Usage Examples

Get the ID of the latest item created on HN:

import { getMaxItemId } from 'hn-ts';

(async () => {
  const id = await getMaxItemId();

  // Output: a number like `27107832`
  console.log(id);
})();

Get the item (story, comment, job, poll or poll option) with the given ID:

import { getItemById } from 'hn-ts';

(async () => {
  const item = await getItemById({
    id: 27107832,
  });

  // Output: `27107832`
  console.log(item.id);

  // Output: `story`
  console.log(item.type);

  // Output: `velut`
  console.log(item.author);
})();

Get the user with the given name:

import { getUserById } from 'hn-ts';

(async () => {
  const user = await getUserById({
    id: "velut",
  });

  // Output: `velut`
  console.log(user.id);
})();

License

MIT License

Copyright (c) 2021 Edoardo Scibona

See LICENSE file.

hn-ts's People

Contributors

dependabot[bot] avatar velut avatar

Watchers

 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.