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

jojitoon-lord-of-the-ring-sdk

v1.0.1

Published

An SDK to access lord of the ring api easily

Downloads

3

Readme

Lord of the Rings SDK

This is a Javascipt SDK for the Lord of the Rings API. It is a wrapper for the Lord of the Rings API.

Installation

npm install --save jojitoon-lord-of-the-ring-sdk

or

yarn add jojitoon-lord-of-the-ring-sdk

API Key

You will need an API key to use this SDK. You can get one here.

Usage

const lordOTRing = require('jojitoon-lord-of-the-ring-sdk')('ApiKey');

in ES6

import LordOTRing from 'jojitoon-lord-of-the-ring-sdk';

const lordOTRing = new LordOTRing('APIKey');

Methods

Movie

Get all movies

lordOTRing.movie.getAll();

Get movie by ID

lordOTRing.movie.get('ID');

Get quote by movie ID

lordOTRing.movie.quotes('ID');

Quote

Get all quotes

lordOTRing.quote.getAll();

Get quote by ID

lordOTRing.quote.get('ID');

Options

The option object is used to filter the results. It is only available in the following methods:

  • lordOTRing.movie.getAll(options)
  • lordOTRing.movie.quotes(options)
  • lordOTRing.quote.getAll(options)

Limit

The number of items to return. Default is 10.

Page

The page number to return. Default is 1.

Offset

The number of items to skip. Default is 0.

Sort By

The field to sort by. Default is _id.

Sort Order

The order to sort by. Default is asc.

Filter

The filter object is used to filter the results by the properties of the return object.

Example

you can pass an object with the following properties to the getAll method to filter the results

This will return the first 10 movies

const options = {
    limit: 10,
    page: 1,
    offset: 0,
    sortBy: 'name',
    sortOrder: 'asc'
    filter: {
        name: 'The Fellowship of the Ring'
    }
}

lordOTRing.movie.getAll(options);

Handling Errors

The SDK will throw an error if the API returns an error. You can catch the error like this:

try {
  const movies = await lordOTRing.movie.getAll();
} catch (error) {
  console.log(error);
}

or

lordOTRing.movie
  .getAll()
  .then((movies) => {
    console.log(movies);
  })
  .catch((error) => {
    console.log(error);
  });

Build

npm run build

or

yarn build

Test

before running the test, you need to create a config.env.test file in the root directory and add your API key to it.

API_KEY=your_api_key

then install dependencies

npm install

or

yarn install

then run the test

npm run test

or

yarn test

Running the Example

before running the example, you need to create a .env file in the root directory and add your API key to it.

API_KEY=your_api_key

then install dependencies

npm install

or

yarn install

then run the example

npm run example

or

yarn example