Lord of the Rings SDK

SDK for the Lord of the Rings API.

Install

npm i @jarcodallo/lotr-sdk

Initialization

Zero configuration

Just import lotr-sdk to your module:

import { LOTR } from '@jarcodallo/lotr-sdk';

const sdk = new LOTR({ apiKey: 'your-api-key' });

Configuration params

@jarcodallo/lotr-sdk can be configured with this options:

interface SDKOptions {
  /**
   * Environment to use. Defaults to `development`.
   */
  env?: Environment;
  /**
   * Logger to use. Defaults to `pino`.
   */
  logger?: BaseLogger;
  /**
   * Logger options.
   */
  loggerOptions?: LoggerOptions;
  /**
   * API URL to use. Defaults to `https://the-one-api.dev`.
   */
  apiUrl?: string;
  /**
   * API version to use. Defaults to `v2`.
   */
  apiVersion?: string;
  /**
   * API key to use.
   */
  apiKey: string;
}

Example

You can run the example with:

npm run examples

Or you can write your own code:

import { LOTR } from '@jarcodallo/lotr-sdk';

// Replace 'your-api-key' with your own API key
const sdk = new LOTR({ apiKey: 'your-api-key' });

const main = async () => {
  // Returns an array of Movies
  const movies = await sdk.getMovies();
  console.log(movies);
  
  // Returns a Movie
  const movie = await sdk.getMovie('5cd95395de30eff6ebccde5c');
  console.log(movie);
  
  // Returns an array of Quotes
  const movieQuotes = await sdk.getMovieQuotes('5cd95395de30eff6ebccde5c');
  console.log(movieQuotes);
  
  // Returns an array of Quotes
  const quotes = await sdk.getQuotes()
  console.log(quotes);
  
  // Returns a Quote
  const quote = await sdk.getQuote('5cd96e05de30eff6ebccfe8e');
  console.log(quote);
};

main();

Change Log

See Changelog for more information.

Collaborators

• Jose Ramirez

License

Licensed under the MIT - see the LICENSE file for details.