Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

waifu-pics-api

Larsundso40MIT1.0.5TypeScript support: included

An up-to-date unofficial wrapper for the Waifu.pics API 100% API Coverage 100% Type-Script coverage

waifu.pics, waifu, api, wrapper

readme

Waifu.Pics API Wrapper

An up-to-date unofficial wrapper for the Waifu.pics API 100% API Coverage 100% TypeScript Coverage 100% JSDoc Coverage

Getting started

import WaifuPics from 'waifu-pics-api';

await WaifuPics('neko'); // returns String
await WaifuPics('neko', { nsfw: true }); // returns String
await WaifuPics('neko', { many: true }); // returns Array of Strings
await WaifuPics('neko', { nsfw: true, many: true }); // returns Array of Strings
await WaifuPics('neko', { many: true, exclude: ['https://i.waifu.pics/xxx.jpg'] }); // returns Array of Strings
await WaifuPics('neko', { nsfw: true, many: true, exclude: ['https://i.waifu.pics/xxx.jpg'] }); // returns Array of Strings

Options

nsfw: boolean
many: boolean
exclude: string[] (Array of URLs)
(All options are optional)

Support

If you need Help, please contact me at Discord or open an Issue on GitHub


Contributing

I will happily accept your Pull-Request if it:

  • looks reasonable
  • does not break backwards compatibility