@z.aourzag/nekos.life-aero v2.0.9

Nekos.life

Installation

npm i -s nekos.life

Official wrapper for nekos.life! Very small install size with no external dependencies.

SFW

NSFW

All of the endpoints but the ones marked with text, except Chat/8Ball/Fact in the description will return JSON: { url: <theURL>}.

sfw.catText will return JSON: {cat: <catemoji>}
sfw.why will return JSON {why: <whytext>}
sfw.OwOify will return JSON {owo: <owoified string>}

sfw.fact will return JSON {fact: <fact string>}
sfw.eightBall will return JSON {response: <8Ball response string>, url: <URL to a matching 8Ball image>}

As of now, OwOify and eightBall are the only ones with query parameters. It requires an object containing the parameter, and the key should be the value. In this case, the key is text and the value is whatever you want OwOified. There is an example in this README. {text: 'Some text you want weebified.}

Typings

I added a typings file and will be working to improve it. This allows editors like VSC to use intellisense/autocomplete to suggest functions and help out with parameters and to see what you'll be receiving as a result of function calls.

Examples

Await/Async example

const client = require('nekos.life');
const neko = new client();

async function test() {
  console.log(await neko.sfw.hug());
}

test();

returns:

{ url: 'https://cdn.nekos.life/hug/hug10050.gif' }

Promise example

const client = require('nekos.life');
const neko = new client();

neko.sfw.catText().then((catText) => console.log(catText));

returns

{ cat: '((≡^⚲͜^≡))' }

OwOify example

const client = require('nekos.life');
const neko = new client();

async function work() {
  let owo = await neko.sfw.OwOify({text: 'This lib is really awesome!'});
  console.log(owo);
}

work();

returns

{ owo: 'This wib is weawwy awesome >w< ' }

NSFW example

const client = require('nekos.life');
const neko = new client();

neko.nsfw.neko().then(neko => {console.log(neko);});

returns

{ url: 'https://cdn.nekos.life/lewd/lewd_neko750.jpeg' }

Advanced examples

Here I'll show you how to import either sfw or nsfw if you would like to do so. That allows you to only use one or the other So if you only need sfw, you can just import that without anything nsfw!

Importing only sfw

const client = require('nekos.life');
const {sfw} = new client();

sfw.neko().then(neko => console.log(neko));

returns

{ url: 'https://cdn.nekos.life/neko/neko_083.jpg' }

Importing only nsfw

const client = require('nekos.life');
const {nsfw} = new client();

nsfw.neko().then(neko => console.log(neko));

returns

{ url: 'https://cdn.nekos.life/lewd/lewd_neko_058.jpeg' }