README
Node Some Random API (NSRA)
Promise-based Node.js wrapper for Some Random API.
About
The NSRA library created in order to simplify and speed up working with the Some Random API in the TypeScript and JavaScript environment. Here are some of the main benefits:
- The library built on the principle of Promises.
- Almost complete coverage of SRA endpoints by the library.
- Continuous improvement and completion.
Installation
Requirements:
- node: 12.0.0 or newer,
- npm: 6.9.0 or newer.
Download library:
Installation using npm:
npm install node-some-random-api
Or, if you are using Yarn, enter this command:
yarn add node-some-random-api
Basic usage
const { SRAClient } = require("node-some-random-api");
const client = new SRAClient("your-token");
client.dog().then((response) => console.log(response));
Examples
You can find some examples here. You can also supplement them by creating a new Pull Request with the written examples.
License
The NSRA library is licensed and published under the GPL-3.0 license. You can read the text of this license here.
© Pelfox & Contributors, 2021. Created on Earth :)