# kinakoneko

> An Anime/Hentai Image API which simplifies how you fetch random images for you! Reliable, and very pleasure friendly!

Latest version **1.0.4** (published 2023-04-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install kinakoneko
pnpm add kinakoneko
yarn add kinakoneko
bun add kinakoneko
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-04-11 |
| First published | 2022-11-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 15.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | KazeDevID |
| Maintainers | kazedevid |
| Keywords | nsfw, hentai, anime, images, wallpaper, discord, neko, cute, as, fubuki, api |

## Links

- npm: https://www.npmjs.com/package/kinakoneko
- Repository: https://gitlab.com/KazeDevID/kinako
- Homepage: https://gitlab.com/KazeDevID/kinako#readme
- Issues: https://gitlab.com/KazeDevID/kinako/issues
- npm.io page: https://npm.io/package/kinakoneko

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.0.4 (latest) — 2023-04-11
- 1.0.3 — 2023-04-02
- 1.0.2 — 2023-03-10
- 1.0.1 — 2022-11-08

## README

## Installation
``npm install kinakoneko``

## Example(s)
**NodeJS:**
```javascript
// kinakoneko //
const kinakoneko = require('kinakoneko');

async function yourFunctionName() {

  // Get SFW Neko Images, uwu //
  console.log("SFW Neko: " + await kinakoneko.neko());

  // Get Lewd Neko (NSFW), owo //
  console.log("Lewd Neko:" + await kinakoneko.lewdNeko());

  // Lewd Bomb me onii-san~~ //
  console.log("Lewd Bomb: " + await kinakoneko.lewdBomb(5));

  // Get other NSFW Images //
  console.log("BDSM: " + await kinakoneko.nsfw.bdsm());
  console.log("Maid: " + await kinakoneko.nsfw.maid());
  console.log("Hentai: " + await kinakoneko.nsfw.hentai());
}

// Call your Function! //
yourFunctionName();
```

## Legacy Function(s)
Example:
```javascript
kinakoneko.function() // Format
kinakoneko.lewdNeko() // Example
kinakoneko.lewdBomb(5) // Meow, I'm Example 2
```
Function | Description
---|---
lewdNeko | NSFW Neko Girls (Cat Girls)
lewdBomb(n) | Sends (n) amount of lewds! :3

## SFW Function(s)
Example:
```javascript
kinakoneko.function() // Format
kinakoneko.foxgirl() // Awoo!~ Another example!
kinakoneko.neko() // Meow! An Example!
```
Function | Description
---|---
neko | SFW Neko Girls (Cat Girls)
foxgirl | SFW Fox Girls

## NSFW Function(s)
Example:
```javascript
kinakoneko.nsfw.function() // Format
kinakoneko.nsfw.hentai() // Example
kinakoneko.nsfw.feet() // Another Example
```
Function | Description
---|---
ass | I know you like anime ass~ uwu
bdsm | If you don't know what it is, search it up
blowjob | Basically an image of a girl sucking on a sharp blade!
cum | Basically sticky white stuff that is usually milked from sharpies.
doujin | Sends a random doujin page imageURL!
feet | So you like smelly feet huh?
femdom | Female Domination?
foxgirl | Girl's that are wannabe foxes, yes
gifs | Basically an animated image, so yes :3
glasses | Girls that wear glasses, uwu~
hentai | Sends a random vanilla hentai imageURL~
netorare | Wow, I won't even question your fetishes.
maid | Maids, Maid Uniforms, etc, you know what maids are :3
masturbation | Solo Queue in CSGO!
orgy | Group Lewd Acts
panties | I mean... just why? You like underwear?
pussy | The genitals of a female, or a cat, you give the meaning.
school | School Uniforms!~ Yatta~!
succubus | Spooky Succubus, oh I'm so scared~ Totally don't suck me~
tentacles | I'm sorry but, why do they look like intestines?
thighs | The top part of your legs, very hot, isn't it?
uglyBastard | The one thing most of us can all agree to hate :)
uniform |Military, Konbini, Work, Nurse Uniforms, etc!~ Sexy~
yuri | Girls on Girls, and Girl's only!<3
zettaiRyouiki | That one part of the flesh being squeeze in thigh-highs~<3

## Wallpaper Function(s)
Example:
```javascript
kinakoneko.nsfw.function() // NSFW Format
kinakoneko.nsfw.mobileWallpapers() // NSFW Example
```

Function | Description
---|---
kinakoneko.mobileWallpapers() | Fetch a random SFW Wallpaper! (Mobile)
kinakoneko.wallpapers() | Fetch a random SFW Wallpaper! (Desktop)
kinakoneko.nsfw.mobileWallpapers() | Fetch a random NSFW Wallpaper! (Mobile)
kinakoneko.nsfw.wallpapers() | Fetch a random NSFW Wallpaper! (Desktop)


## How to Resolve Promises
```javascript
// Just Calling my dear child, kinakoneko //
const kinakoneko = require('kinakoneko');

// Option 1, using and calling an asyncronous function //
async function yourFunctionName() {
  console.log(await kinakoneko.nsfw.maid()); // Output: Some weird long link that you probably will definitely try to open //
}

// Don't forget to call your function! //
yourFunctionName();

// Option 2, Using ".then" //
kinakoneko.nsfw.maid().then((imageURL) => {
  console.log(imageURL);
})
```


##
Discord Bot Example
```javascript
const Discord = require('discord.js');
const kinakoneko = require('kinakoneko');

// Create New Client //
const client = new Discord.Client();

// Bot Settings //
const settings = {
  prefix: "YOUR_BOT_PREFIX",
  token: 'YOUR_BOT_TOKEN'
}

// On "Message" Event! //
client.on('messageCreate', async (message) => {

  // Checks if message channel is NSFW! //
  if (!message.channel.nsfw) return message.channel.send('Sorry! Not NSFW Channel!');

  // Create New Embed //
  const embed = new Discord.MessageEmbed();

  // Defines Command //
  var command = message.content.toLowerCase().slice(settings.prefix.length).split(' ')[0];

  // Onii-chan, don't reply! //
  if (!message.content.startsWith(settings.prefix) || message.author.bot) return;

  if (command == 'lewdneko') {

    // For Embed //
    embed.setImage(await kinakoneko.lewdNeko());
    return message.channel.send({ embeds: [embed] });

    // For Plain Text //
    return message.channel.send(await kinakoneko.lewdNeko());

  } else if (command == 'maid') {

    // For Embed //
    embed.setImage(await kinakoneko.nsfw.maid());
    return message.channel.send({ embeds: [embed] });

    // For Plain Text //
    return message.channel.send(await kinakoneko.nsfw.maid());
    
  }

}


});
```

## Support
[DONATE](https://saweria.co/KazeDevID)

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