the-one-node v1.0.9

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>);