@titus_entertainment/api

A lightweight and easy to use client wrapper for my reddit caching api.

Tables of content

- Motivation
- Features
- Installation
- Common Usage
- Contribution
- Licence and Final Words

Motivation

Instead of having to define functions, queries and having to get node-fetch among other things I though that it would be easier to document and use a wrapper.

Features

- Automatic querying.
- Checks for anomalies in the replies from the API.
- Uses promises, which in return allows for asynchronus operations.

Installation

node:

npm i @titus_creations/api

yarn

yarn add @titus_creations/api

Common Usage

Simply get the client by deconstructing the require.

``js
const { TitusClient } = require('@titus_creations/api');
`

Then initalize it

`js
const client = new TitusClient();
`

if you're selfhosting the reddit caching api. You can tell the wrapper to use your url instead.

`js
const client = new TitusClient({ url: 'http://myurl' });
`

example:

- meme

`js
// If you're not in an async function you can use .then()
const meme = client.getMeme().then(res => console.log(res));

// Otherwise use await, like so;

const meme = await client.getMeme();
console.log(meme);
``

Avalible methods:

- getMeme();
- getUnixPorn();
- getNsfw();
- getHentai();

Contributing

Would you like to contribute to this project?

if you have a change you would like to make to the code please provide a code sample and a reason for the change.

Licence and Final Words

I would like to thank [2D]() for giving me this idea in the middle of the night and helping me along the way!

@titus_creations/api © Titus
Authored and maintained by Titus.

> GitHub @TitusEntertainment
> Npm @Titus_entertainment