# @joshuajc/ringapi

> Utility for Lord of Rings API

Latest version **1.0.8** (published 2022-12-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @joshuajc/ringapi
pnpm add @joshuajc/ringapi
yarn add @joshuajc/ringapi
bun add @joshuajc/ringapi
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2022-12-01 |
| First published | 2022-12-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 15.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | joshua |
| Maintainers | joshuajc |
| Keywords | Lord of Rings |

## Links

- npm: https://www.npmjs.com/package/@joshuajc/ringapi
- npm.io page: https://npm.io/package/@joshuajc/ringapi

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^1.2.0
- [ts-node](https://npm.io/package/ts-node.md) ^10.9.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.0
- [@types/node-fetch](https://npm.io/package/@types/node-fetch.md) ^2.6.2

## Recent versions

- 1.0.8 (latest) — 2022-12-01
- 1.0.7 — 2022-12-01
- 1.0.6 — 2022-12-01
- 1.0.5 — 2022-12-01
- 1.0.4 — 2022-12-01
- 1.0.3 — 2022-12-01
- 1.0.2 — 2022-12-01
- 1.0.1 — 2022-12-01
- 1.0.0 — 2022-12-01

## README

# @joshuajc/ringapi SDK

## About


The @joshuajc/ringapi Node SDK allows you to quickly and easily integrate Lord of Ring Api effortlessly.

Rest API Documentation can be found on this [url](https://the-one-api.dev/documentation).

You have to signup on this platform to get accesskey.

#### Note

This Readme provide basic installation and usage information.

## Installation


> npm install @joshuajc/ringapi

## Usage


You can use this library based on JS/TS method chaining.

```
// get book list
import RingAPI from '@joshuajc/ringapi';

const books = await RingAPI.getBooks();

//output will be json array containing books data

```

You can insert filtering, sorting, pagination before getting specific data.

```
import RingAPI from '@joshuajc/ringapi';

const books = await RingAPI.setSorting('asc').getBooks() // set ascending order

const books = await RingAPI.setPaginationPage(2).getBooks() // set 2nd page and get result

// You can combine multile function calls by chaining

const books = await RingAPI.setPaginationOffset(12).setSorting('desc').getBooks() // set both of page offset and sorting

// You should set auth token before calling sensitve datas

const acccessTokenString = "abcdddssdf1s"; // you should replace this with real token

const movieId = 'a34d43"

const movie = await RingAPI.setAccessToken(tokenString).setPaginationPage(1).setSorting('asc').getMovie(movieId);


```

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