Leke-lotr-toolkit NPM

LOTR Toolkit SDK

This SDK allows developers to interact with the Lord of the Rings API seamlessly. It is written in TypeScript and provides methods to retrieve information about movies and quotes from the Lord of the Rings trilogy.

Features
Installation
Getting Started
Usage
Sample
Testing
Contribute

Features

Retrieve information about movies.
Retrieve movie details by ID.
Retrieve quotes from the movies.
Retrieve quote details by ID.
Retrieve quotes by movie ID.

Installation

You can install this SDK via npm. First, make sure you have Node.js installed on your machine, and then run:

npm install leke-lotr-toolkit

Getting Started

To get started, you need to have an API key from the Lord of the Rings API. You can get it by registering here.

After obtaining the API key, create a .env file in the root directory of your project and add the API key like this:

API_KEY=your_api_key_here

Make sure to add .env to your .gitignore file to avoid exposing your API key.

Usage

Import the SDK in your TypeScript or JavaScript file and initialize it with your API key:

const { LotrClient } = require('leke-lotr-toolkit');

// Initialize the client with your API key
const client = new LotrClient('your-api-key');

Here are some examples of how you can use the SDK to interact with the API:

Fetch all movies

// Use the SDK to retrieve data from the API
const movies = await client.movieService.getAllMovies();
console.log(movies);

Fetch a specific movie by ID

const movieById = await client.movieService.getMovieById('movie-id');
console.log(movieById);

Fetch all quotes

const quotes = await client.quoteService.getAllQuotes();
console.log(quotes);

Fetch a specific quote by ID

const quoteById = await client.quoteService.getQuoteById('quote-id');
console.log(quoteById);

Fetch all quotes for a specific movie

const quotesByMovieId = await client.quoteService.getQuotesByMovieId('movie-id');
console.log(quotesByMovieId);

Paginating Results

Pagination is supported for results that return lists of movies or quotes. To paginate the results, you can use the offset and limit query parameters when calling the relevant SDK methods. To paginate, create an object with offset and limit parameters (integers) and pass it to one of the following functions:

getAllMovies()
getAllQuotes())
getQuotesByMovieId

Example:

const options = { limit: 2, offset: 0 };
const movies = await client.movieService.getAllMovies(options);

Sample

A sample file demonstrating the usage of the SDK is available in the src/sample.ts file. To run the example, make sure you have set up your .env file as described above, build and then execute:

node sample.js