@skapicic/lotr-sdk

LOTR-SDK

Lord of the Rings SDK

Getting started

Installation:

npm install @skapicic/lotr-sdk

Registration:

Sign up in order to obtain an API key!

Initialisation:

import { LotrClient } from '@skapicic/lotr-sdk';

const lotrClient = new LotrClient('YOUR_API_KEY');

That's it!

Basic usage

Entities that are supported for the current version are

• Books
• Chapters
• Characters
• Movies
• Quotes

All the mentioned entities support getting by id or list. The list API supports pagination, sorting and filtering. (see examples) All methods return Promises that are free to use asynchronously throughout the code.

Additional methods

The following additional methods are supported by the sdk.

• Chapters by book - bookChapters(bookId: string, query: query)
• Quotes by movie - movieQuotes(movieId: string, query: query)
• Quotes by character - bookChapters(characterId: string, query?: query)

Rate limit

There is a rate limit of 100 requests per 10 min so use with caution!

Filter API

There is included support for filtering via an api. The syntax is simple:

lotrClient.filter('$FIELD_NAME').$OPERAND;

Where the $OPERAND can be substituted with any of the following:

• matches(value: string, negate?: boolean) - field is an exact match
• includes(values: string[], negate?: boolean) - field includes at least one value
• regex(value: string, negate?: boolean) - matches Regular Expression
• exists(negate?: boolean) - field exists
• greaterThan(value: number, orEquals?: boolean) - field is greater than (orEquals)
• lesserThan(value: number, orEquals?: boolean) - field is lesser than (orEquals)

IMPORTANT: Although it is possible to chain multiple operands on a Filter
e.g. lotrClient.filter('name').matches('Frodo').includes(['Gandalf'])
the last used operand will overwrite the whole chain so this should rarely/never be used

Examples

Book by id:

lotrClient.book('5cf5805fb53e011a64671582');

All books:

lotrClient.books();

Paginated, sorted or filtered books:

lotrClient.books({
    page: 1,
    limit: 10, 
    sort: { by: 'name', direction: 'asc' },
    filters: [
        lotrClient.filter('name')
            .matches('The Return Of The King')
    ]
});