# alexander-leroux-sdk

> An SDK for accessing the Lord of the Rings API

Latest version **1.0.1** (published 2023-01-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install alexander-leroux-sdk
pnpm add alexander-leroux-sdk
yarn add alexander-leroux-sdk
bun add alexander-leroux-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-01-08 |
| First published | 2023-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alexander Leroux |
| Maintainers | alleroux |
| Keywords | API, lordoftherings |

## Links

- npm: https://www.npmjs.com/package/alexander-leroux-sdk
- Repository: https://github.com/alleroux/alexander-leroux-sdk
- Homepage: https://github.com/alleroux/alexander-leroux-sdk#readme
- Issues: https://github.com/alleroux/alexander-leroux-sdk/issues
- npm.io page: https://npm.io/package/alexander-leroux-sdk

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.2.2

## Recent versions

- 1.0.1 (latest) — 2023-01-08
- 1.0.0 — 2023-01-08

## README

# The One API SDK
This is a JavaScript SDK for the purpose of gaining access to The One API located at https://the-one-api.dev/.
The SDK uses Axios to make requests to the API and returns the result of the request as an object.  You should use async/await syntax to capture the value of the response.

## Requirements

To use this SDK you will need Node.js (https://nodejs.org/)

## Installation

`npm install alexander-leroux-sdk`

`import TheOneAPISDK from "alexander-leroux-sdk";`

In order to connect to the API you will need to create a file in the router directory of your project called secret.json.  You can copy secret.example.json from the repository and overwrite the accessToken property with your own access token.  Register an account at https://the-one-api.dev in order to create an access token.

## Usage

See sample code in samples directory.

```
const theOneAPI = new TheOneAPISDK();

theOneAPI.getMovie("theMovieId")
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });
```

## Available methods
- `getMovie(movieId)`

## API Documentation

API Documentation created via JSDoc is available in the `out` directory.

---
_Source: https://npm.io/package/alexander-leroux-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._