# waifu.pics.js

> A powerful waifu.pics api wrapper for NodeJS.

Latest version **0.0.5** (published 2021-05-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install waifu.pics.js
pnpm add waifu.pics.js
yarn add waifu.pics.js
bun add waifu.pics.js
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2021-05-05 |
| First published | 2021-03-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Yonle |
| Maintainers | yonle |
| Keywords | waifu.pics |

## Links

- npm: https://www.npmjs.com/package/waifu.pics.js
- Repository: https://github.com/Yonle/waifu.pics.js
- Homepage: https://github.com/Yonle/waifu.pics.js#readme
- Issues: https://github.com/Yonle/waifu.pics.js/issues
- npm.io page: https://npm.io/package/waifu.pics.js

## Recent versions

- 0.0.5 (latest) — 2021-05-05
- 0.0.4 — 2021-03-19
- 0.0.3 — 2021-03-16
- 0.0.2 — 2021-03-16
- 0.0.0 — 2021-03-16

## README

<div align="center">

[![waifu.pics](https://waifu.pics/favicon.png)](https://waifu.pics)

# Waifu.pics.js
A powerful waifu.pics api wrapper for NodeJS. <br>
[![Latest Stable Version](https://img.shields.io/npm/v/waifu.pics.js.svg)](https://www.npmjs.com/package/waifu.pics.js)
[![NPM Downloads](https://img.shields.io/npm/dt/waifu.pics.js.svg)](https://www.npmjs.com/package/waifu.pics.js)
[![NPM Downloads](https://img.shields.io/npm/dm/waifu.pics.js.svg)](https://www.npmjs.com/package/waifu.pics.js)
![npm bundle size](https://img.shields.io/bundlephobia/min/waifu.pics.js)
![GitHub repo size](https://img.shields.io/github/repo-size/Yonle/waifu.pics.js)
![node-current](https://img.shields.io/node/v/waifu.pics.js)
</div>


- [Install](#install)
- [API](#api)
  - [`core`](#core)
  - [`core.<type>`](#coretype)
  - [`core.<type>.categories`](#coretypecategories)
  - [`core.<type>.many`](#coretypemany)
- [Community](#community)
- [Useful Link](#usefullink)
# Install
```
npm install waifu.pics.js
```
## API
### `core`
A functions that loaded from `require("waifu.pics.js")`, Fetching many `waifu` url from [waifu.pics](https://waifu.pics) endpoint. Returns `Promise { <pending> }`
```js
const waifu = require("waifu.pics.js");

waifu().then(json => {
	/*
		{
			files: [
				'https://i.waifu.pics/uc-SymC.jpg',
				....
			]
		}
	*/
}).catch(console.error);

// Or
(async () => {
	var response = await waifu();
	// { files: [ .... ] }
})();
```
### `core.<type>` 
A function that fetch a requested waifu type, Waifu has 2 types, They are `sfw` and `nsfw` Returns `Promise { <pending> }`
```js
waifu.sfw("neko").then(json => {
	// { url: 'https://i.waifu.pics/vwNedaS.jpg' }	
}).catch(console.error);

// Or
(async () => {
	var response = await waifu.sfw("neko")();
	// { url: '....' }
})();
```
### `core.<type>.categories`
A object property that returns all `<waifu type>` categories key, Returns `object`
```js
console.log( waifu.sfw.categories );
/*
	[
 	  'waifu',    'neko',     'shinobu',
	  'megumin',  'bully',    'cuddle',
	  'cry',      'hug',      'awoo',
	  'kiss',     'lick',     'pat',
	  'smug',     'bonk',     'yeet',
	  'blush',    'smile',    'wave',
	  'highfive', 'handhold', 'nom',
	  'bite',     'glomp',    'kill',
	  'slap',     'happy',    'wink',
	  'poke',     'dance',    'cringe'
	]
*/
```
### `core.<type>.many`
Same as [`core.<type>`](#coretype) does, but returns many url from requested categories. Returns `Promise { <pending> }`
```js
waifu.sfw.many("smile").then(json => {                                                                                       /*
                {
                        files: [                                                                                                     'https://i.waifu.pics/uc-SymC.jpg',
                                ....
                        ]
                }
        */
}).catch(console.error);

// Or
(async () => {
	var response = await waifu.sfw.many("smile");
	// { files: [ .... ] }
})();
```

# Community
- [Discord](https://quickstream.yonle.repl.co/discord)
- [Telegram](https://t.me/yonlecoder)

# Useful Link
- [Waifu.pics Github](https://github.com/Riku32/waifu.pics)

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