npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

codemask-lotr-sdk

v1.0.4

Published

Lord Of The Rings API SDK

Downloads

3

Readme

SDK for Lord-of-the-Ring API

This SDK provides easy access to the Lord of the Rings API endpoints for movies and quotes.

Documentation

The official documentation for The Lord-of-the-Ring API can be found here

This SDK library currently supports the Movie and Quote endpoints:

  • /movie
  • /movie/{id}
  • /movie/{id}/quote
  • /quote
  • /quote/{id}

Installation

Install the sdk library with npm


npm install codemask-lotr-sdk

Usage/Examples

To use the SDK, import the LotrSDK function and initialize by passing the following configuration parameters:

The following parameters are accepted:

apiToken (Required): The API access token. You must create an account to get a valid token.

baseURL (Optional): The Default base URL is https://the-one-api.dev/v2. It's subject to change from time to time, please check the main site.

Example Usage with javascript/typescript

import { LotrSDK } from '@codemask-lotr-sdk';

const sdk = new LotrSDK({
  apiToken: 'YOUR_API_TOKEN'
});


// retrieve all movies
const allMovies = sdk.movies.getAllMovies();

console.log(allMovies);

// retrieve all quotes
const allQuotes = sdk.quotes.getAllQuotes()

console.log(allQuotes);

Available Methods

The SDK provides the following methods for interacting with the LOTR API:

Movies API methods

  • To retrieve all movies

    movie.getAllMovies(queryOptions?: QueryOptions)

  • To retrieve a single movie by ID

    movie.getMovieById(id: string, queryOptions?: QueryOptions)

  • To retrieve movie quotes by the movie ID.

    movie.getMovieQuotes(id: string, queryOptions?: QueryOptions)

Quotes API methods

  • To retrieve all quotes.

    quote.getAllQuotes(queryOptions?: QueryOptions)

  • To retrieve a quote by its ID.

    quote.getQuoteById(id: string, queryOptions?: QueryOptions)

Running Tests

To run tests, run the following command

  npm run test