You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lio 763fe327a6
v
3 months ago
.github/workflows remove GPR publish from workflow 6 months ago
src fix E?? 3 months ago
.gitignore yeet this is a breaking change don't use me yet i'm not done yet 7 months ago
.npmignore yeet this is a breaking change don't use me yet i'm not done yet 7 months ago
README.md v3.0.3 add gelbooru to readme 6 months ago
index.ts add thaldrin 6 months ago
package-lock.json add ts to dev deps 6 months ago
package.json v 3 months ago
tsconfig.json add test scripts 3 months ago

README.md

yiff by Lio

NPM

VERSION 3 IS A BREAKING CHANGE

*Do not update from v2 if your current code is still based on v2*

If you need Support or want more Information, join my discord server

⭐️ Supported APIs

Yiff, by default, uses the main Killswitch Instance as a Proxy for any Requests.

Usage

import Yiff from "yiff";

// every object in the config is optional
let config = {
  useragent: `Project/version (website)`;
    killswitch: {
        enabled: true
        instance: "https://yiff.click"
    }
    apikey: {
        sheri: "<Your Token>";
        yiffrest: "<Your Token>";
        e621: "<Your Token>";
        e926: "<Your Token>";
    }
}
const yiff = new Yiff(config);

let tags = "werewolf male/male"
let limit = 1
// Basically:

yiff.e621(tags, limit).then((r) => {console.log("e621", r)})
// => Unfiltered E621 Response

yiff.e926(tags, limit).then((r) => {console.log("e926", r)})
// => Unfiltered E926 Response

yiff.yiffy('animals', 'birb').then((r) => {console.log("yiffy", r)})
// => Unfiltered yiff.rest Response

yiff.floofy().then((r) => {console.log("floofy", r)})
// => Unfiltered api.floofy.dev Response

yiff.sheri('paws').then((r) => {console.log("sheri", r)})
// => Unfiltered sheri.bot Response

yiff.shibe("shibes", 2).then((r) => {console.log("shibes", r)})
// => Unfiltered shibe.online Response

yiff.fox().then((r) => {console.log("fox", r)})
// => Unfiltered randomfox.ca Response

❓ FAQ

Q: Will you add other APIs as well?
A: Depends on if they're either free or I get an all-access token, as well as if there's proper documentation for the API

Contributing & Issues

Feel free to make a Pull request and fix some things, otherwise just open a Issue or join my discord server and let me know what you want added!