# @my-fuyuumi/fuyuumi-apijs

> Lightweight JavaScript wrapper for the https://my.fuyuumi/ API

Latest version **1.0.0** (published 2021-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @my-fuyuumi/fuyuumi-apijs
pnpm add @my-fuyuumi/fuyuumi-apijs
yarn add @my-fuyuumi/fuyuumi-apijs
bun add @my-fuyuumi/fuyuumi-apijs
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-04-22 |
| First published | 2021-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | KASKUSTTV |
| Maintainers | kaskusttv |
| Keywords | wrapper, nekos, neko, api |

## Links

- npm: https://www.npmjs.com/package/@my-fuyuumi/fuyuumi-apijs
- Repository: https://github.com/my-fuyuumi/fuyuumi-api.js
- Homepage: https://github.com/my-fuyuumi/fuyuumi-api.js#readme
- Issues: https://github.com/my-fuyuumi/fuyuumi-api.js/issues
- npm.io page: https://npm.io/package/@my-fuyuumi/fuyuumi-apijs

## Recent versions

- 1.0.0 (latest) — 2021-04-22

## README

## Installation
```
npm install @my-fuyuumi/fuyuumi-api.js --save
```

## Example

Async/Await example
```js
const Neko = require('@my-fuyuumi/fuyuumi-api.js');

async function test() {
  console.log(await Neko("neko")); 
}
test();

async function test() {
  console.log(await Neko("endpoint")); // Returns the list of endpoints
}
test();
```

Promise example
```js
const Neko = require("@my-fuyuumi/fuyuumi-api.js");

Neko("neko").then((res) => {
    console.log(res);
});

Neko("endpoint").then((res) => {
    console.log(res); // Returns the list of endpoints
});
```

## Endpoints

### SFW

| Function | Description |
| -------- | ----------- |
| `neko` | Get a URL of a neko image |
| `slap` | Gets a URL of a slap image/gif |
| `pat`  | Get a URL of a pat image/gif |
| `kiss` | Get a URL of a kiss image/gif |
| `hug`  | Get a URL of a hug image/gif |
| `kitsune` | Get a URL of a fox girl image |
| `pat` | Get a URL of a pat image/gif |
| `cry` | Get a URL of a cry image/gif |
| `waifu` | Get a URL of a waifu image |
| `smug` | Get a URL of a smug image |
| `punch` | Get a URL of a punch image |


[Full Neko Love API documentation](https://docs.fuyuumi.ga/api/)

## Links

*   [Website](https://my.fuyuumi.ga)
*   [Documentation](https://docs.fuyuumi.ga/api)
*   [Discord](https://discord.gg/byThR3v)
*   [NPM](https://npmjs.com/@my-fuyuumi/fuyuumi-api,js)

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