lordoftherings-sdk-js

Lord of the Rings SDK

The Lord of the Rings SDK is a TypeScript library that provides convenient access to The One API's Lord of the Rings resources. It allows you to retrieve information about movies and quotes from the Lord of the Rings series.

Installation

Install the SDK using npm:

npm install lordoftherings-sdk-js

Usage

To use the Lord of the Rings SDK in your project, follow these steps:

• Import the SDK and create an instance of the LordOfTheRings class:

import { LordOfTheRings } from 'lordoftherings-sdk-js';

const lotr = new LordOfTheRings({ accessToken: 'YOUR_ACCESS_TOKEN' });

Replace YOUR_ACCESS_TOKEN with your actual API access token obtained from The One API.

Available Functions

Function	Description	Parameters
movies.get()	Retrieve a list of movies	requestParams?: RequestParams (optional pagination, sorting, and filtering parameters)
movies.getByMovieId(id)	Get a specific movie by its ID	id: string, requestParams?: RequestParams (optional pagination, sorting, and filtering parameters)
movies.getQuotesByMovieId(id)	Get quotes for a specific movie by its ID	id: string, requestParams?: RequestParams (optional pagination, sorting, and filtering parameters)
quotes.get()	Retrieve a list of quotes	requestParams?: RequestParams (optional pagination, sorting, and filtering parameters)
quotes.getByQuoteId(id)	Get a specific quote by its ID	id: string, requestParams?: RequestParams (optional pagination, sorting, and filtering parameters)

Examples

// Retrieve a list of movies
const moviesResponse = await lotr.movies.get();

// Get quotes for a specific movie
const movieId = 'MOVIE_ID';
const quotesResponse = await lotr.movies.getQuotesByMovieId(movieId);

Running Tests

The Lord of the Rings SDK includes tests using the Jest framework. To run the tests, follow these steps:

• Install the dependencies (if not already installed):

npm install

• Run the tests:

npm test

The tests will be executed, and the results will be displayed in the console.

Contributing

Contributions are welcome! If you find any issues or would like to add new features or improvements, please submit a pull request.

Before submitting a pull request, make sure to:

• Write tests to cover the changes or additions
• Run the existing tests to ensure they pass
• Follow the existing code style and conventions

License

The Lord of the Rings SDK is released under the MIT License. See the LICENSE file for more details.