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

the-one-node

v1.0.9

Published

The One APK for Node

Downloads

22

Readme

The One API Lord of the Rings SDK for Node

This SDK allows Node.js developers to more easily access The One API in their projects. You can find additional documentation about The One API, which provides informatin about the Lord of the Rings books and movies, at its GitHub repo here.

Getting started

To install this package, run npm install the-one-node.

Getting your access token

The Lord of the Rings API requires an access token to use most of its endpoints. To create an access token:

  • Navigate here.
  • You will be prompted to create an account.
  • After creating an account, log in with your new credentials to get your access token.
  • Save your access token in a secure place with your other secrets.
  • Do not commit your access token into source control.
  • You will need to send this token with every function call

Movie Functions

This SDK exposes two endpoints from The One API as convenient front end functions. We will soon be adding more functionality to this SDK.

All movie functions will return a response object shaped like this:

    docs:
        {
            _id: string,
            "name": string,
            "runtimeInMinutes": number,
            "budgetInMillions": number,
            "boxOfficeRevenueInMillions": number,
            "academyAwardNominations": number,
            "academyAwardWins": number,
            "rottenTomatoesScore": number
        }[],
    total: number,
    limit: number,
    offset: number,
    page: number,
    pages: number
}```

### getAllMovies

This endpoint returns an array of movie records.

Example usage:
> import { getAllMovies } from 'the-one-node';
> 
> const allMovies = await getAllMovies(<YOUR-API-TOKEN_HERE>);

#### Search, Sort and Filter

The getAllMovies function will soon support searching, sorting, pagination and filtering. Simply pass in an optional config parameter as described in The One API's documentation [here](https://the-one-api.dev/documentation#5).

### getMovie

This endpoint returns a single movie record.

Example usage:
> import { getMovie } from 'the-one-node';
> 
> const myFaveLotrMovie = await getMovie(<YOUR-API-TOKEN_HERE>, <YOUR-FAVE-MOVIE-ID-HERE>);