# [nekos-best.js](https://www.npmjs.com/package/nekos-best.js)
High quality nekos and role-playing GIFs powered by **[nekos.best](https://nekos.best)**!
This is the official API wrapper for the **[nekos.best](https://nekos.best)**'s API with built-in TypeScript typings.
**[Node LTS](https://nodejs.org/en/download/)** is recommended.
Join the official Discord server **[here](https://nekos.best/discord?ref=js)**
## Installation
`npm install nekos-best.js` | `yarn add nekos-best.js` | `pnpm install nekos-best.js` | `bun install nekos-best.js`
## Usage
```js
import { Client, fetchRandom } from "nekos-best.js";
// You can use the `fetchRandom()` function to fetch a random neko.
console.log(await fetchRandom("neko")); // { results: [{ artist_href: '···', artist_name: '···', source_url: '···', url: 'https://nekos.best/api/v2/neko/XXXXX-XXXXX.png' }] }
// Alternatively, you can initialize a new client which offers more features.
const nekosBest = new Client();
// Such as the `.fetch()` method.
console.log(await nekosBest.fetch("neko", 1)); // { results: [{ artist_href: '···', artist_name: '···', source_url: '···', url: 'https://nekos.best/api/v2/neko/XXXXX-XXXXX.png' }] }
console.log(await nekosBest.fetch("hug", 10)); // { results: [{ artist_href: '···', artist_name: '···', source_url: '···', url: 'https://nekos.best/api/v2/hug/XXXXX-XXXXX.gif' }, ···] }
// Or the `.fetchFile()` method to get a single file.
console.log(await nekosBest.fetchFile("neko")); // { artist_href: '···', ···, data: }
```
### Build a simple Discord Bot with [`discord.js`](https://www.npmjs.com/package/discord.js)
```js
import { Client as DiscordClient } from "discord.js";
import { Client } from "nekos-best.js";
const discordClient = new DiscordClient();
const nekosBest = new Client();
discordClient.on("messageCreate", async (message) => {
if (message.author.bot) return;
if (message.content.startsWith("!neko")) {
message.channel.send((await nekosBest.fetch("neko", 1)).results[0].url);
}
});
discordClient.login(
"************************.******.***************************",
);
```
## Migration guide
Please refer to [MIGRATION.md](https://github.com/nekos-best/nekos-best.js/blob/main/MIGRATION.md).
