cal-sdk
v1.0.0
Published
## Introduction
Downloads
2
Readme
LOTR API SDK for TypeScript
Introduction
A TypeScript SDK for the LOTR API.
You can find examples of using this SDK in the examples/ directory
Getting Started
API Token
To use the SDK you need an API key, sign up for one here: https://the-one-api.dev/sign-up
Installation
npm i cal-sdk
Testing
npm run test
Limitations
Current SDK queries do not make filtering results available.
Currently only the Books endpoint for 'getAll' has test coverage.
NPM package can be reduced in size.
Examples
To try the SDK, the ./examples
directory has a set of SDK functions ready to showcase.
To try the examples, simply rename config.example.ts
to config.ts
and input your own API_KEY.