The official API wrapper for the Purrbot.site API 100% API Coverage 100% Type-Script coverage
npm install purrbot-apiThe official™️ Wrapper for the purrbot.site API
100% API Coverage
100% TypeScript Coverage
100% JSDoc Coverage
100% Test Coverage
``js
import PurrBot from 'purrbot-api';
PurrBot.get('img', false, 'neko'); // returns Promise
PurrBot.list('gif', false, 'neko'); // returns Promise
PurrBot.sfw.get('gif', 'neko'); // returns Promise
PurrBot.sfw.list('gif', 'neko'); // returns Promise
PurrBot.sfw.gif.get('neko'); // returns Promise
PurrBot.sfw.gif.list('neko'); // returns Promise
PurrBot.sfw.img.get('neko'); // returns Promise
PurrBot.sfw.img.list('neko'); // returns Promise
PurrBot.sfw.categories.neko('gif'); // returns Promise
PurrBot.sfw.categories.senko(); // returns Promise
// NSFW Categories have the same Syntax
PurrBot.owoify("Hello World!"); // returns Promise
PurrBot.owoify("Hello World!", { emoticons: true }); // returns Promise
PurrBot.owoify("Hello World!", { replaceWords: true, stutter: true }); // returns Promise
`
#### Options
NSFW / SFW Categories:
`img
imgType: either or gif`
nsfw: boolean
category: string
Owoify:
```
text: string
sutter?: boolean
replaceWords?: boolean
emoticons?: boolean
If you need Help, please contact me at Discord or open an Issue on GitHub
I will happily accept your Pull-Request if it:
- looks reasonable
- does not break backwards compatibility