Lord of the Rings Node.js Library

The Lord of the Rings Node.js library provides an easy way to access information about the Lord of the Rings movies from the API provided by the-one-api.

Requirements

Node.js version 12 or higher

Installation

Use one of the following commands in your favorite terminal:

npm install lotr-sdk-vroy
# or
yarn add lotr-sdk-vroy

Usage

You'll need an access key from the-one-api account area here: https://the-one-api.dev/sign-up.

const { lotr } = require('lotr-sdk-vroy');

lotr('your_key_from_one_api').movie.list({})
  .then(resp => console.log(resp.docs))
  .catch(error => console.error(error));

Or using ES modules and async/await:

import { lotr } from 'lotr-sdk-vroy';
const lotrClient = lotr('some_api_key_from_one_api')

const {docs: movies} = await lotrClient.movie.list({})

console.log(movies);

Usage with TypeScript

import { lotr } from 'lotr-sdk-vroy';
const lotrClient = lotr('some_api_key_from_one_api')

const {docs: movies} = await lotrClient.movie.list({})
// movies will have typese
console.log(movies);

Configuration

The following configuration options are available. They can be set on a per-request basis and on a global basis.

| Option | Default | Description | | ------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | host | 'the-one-api.dev' | Host that requests are made to. | | httpClient | fetch from node-fetch | the fetch/http client to use for the request | | maxNetworkRetries | 0 | The amount of times a request should be retried | | protocol | 'https' | 'https' or 'http'. Do not use http in production | | timeout | 10000 | [Maximum time each request can take in ms.] |

Development

Run all tests:

$ npm install
$ npm test