purrbot-api/src/sfw.ts

The official API wrapper for the Purrbot.site API 100% API Coverage 100% Type-Script coverage

import { SFWCategories } from './types.js';
import { get, list } from './util.js';

export default {
 /**
  * @param category {string} one of SFWCategories<T> or NSFWCategories<T> - see https://docs.purrbot.site/api/
  * @param imgType {string} `gif` or `img`
  * @returns {Promise<string[]>}
  * @example
  * import PurrBot from 'purrbot-api';
  * PurrBot.sfw.list('img', 'neko').then(console.log);
  * // => ['https://purrbot.site/img/xxx.jpg', 'https://purrbot.site/img/xxx.jpg', ...]
  */
 list: <T extends keyof SFWCategories>(imgType: T, category: SFWCategories[T]): Promise<string[]> =>
  list(imgType, false, category),
 /**
  * @param category {string} one of SFWCategories<T> or NSFWCategories<T> - see https://docs.purrbot.site/api/
  * @param imgType {string} `gif` or `img`
  * @returns {Promise<string>}
  * @example
  * import PurrBot from 'purrbot-api';
  * PurrBot.sfw.get('img', 'neko').then(console.log);
  * // => https://purrbot.site/img/xxx.jpg
  */
 get: <T extends keyof SFWCategories>(imgType: T, category: SFWCategories[T]): Promise<string> =>
  get(imgType, false, category),
 gif: {
  /**
   * @param category {string} one of SFWCategories<T> or NSFWCategories<T> - see https://docs.purrbot.site/api/
   * @returns {Promise<string[]>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.gif.list('neko').then(console.log);
   * // => ['https://purrbot.site/img/xxx.jpg', 'https://purrbot.site/img/xxx.jpg', ...]
   */
  list: (category: SFWCategories['gif']): Promise<string[]> => list('gif', false, category),
  /**
   * @param category {string} one of SFWCategories<T> or NSFWCategories<T> - see https://docs.purrbot.site/api/
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.nsfw.gif.get('neko').then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  get: (category: SFWCategories['gif']): Promise<string> => get('gif', false, category),
 },
 img: {
  /**
   * @param category {string} one of SFWCategories<T> or NSFWCategories<T> - see https://docs.purrbot.site/api/
   * @returns {Promise<string[]>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.img.list('neko').then(console.log);
   * // => ['https://purrbot.site/img/xxx.jpg', 'https://purrbot.site/img/xxx.jpg', ...]
   */
  list: (category: SFWCategories['img']): Promise<string[]> => list('img', false, category),
  /**
   * @param category {string} one of SFWCategories<T> or NSFWCategories<T> - see https://docs.purrbot.site/api/
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.img.get('neko').then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  get: (category: SFWCategories['img']): Promise<string> => get('img', false, category),
 },
 categories: {
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.background().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  angry: (): Promise<string> => get('gif', false, 'angry'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.background().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  pout: (): Promise<string> => get('gif', false, 'pout'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.background().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  background: (): Promise<string> => get('img', false, 'background'),
  /**
   * @returns {Promise<string>}
   * @param imgType {string} `gif` or `img`
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.eevee('img').then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  eevee: <T extends keyof SFWCategories>(imgType: T): Promise<string> =>
   get(imgType, false, 'eevee'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.holo().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  holo: (): Promise<string> => get('img', false, 'holo'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.icon().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  icon: (): Promise<string> => get('img', false, 'icon'),
  /**
   * @returns {Promise<string>}
   * @param imgType {string} `gif` or `img`
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.kitsune('img').then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  kitsune: <T extends keyof SFWCategories>(imgType: T): Promise<string> =>
   get(imgType, false, 'kitsune'),
  /**
   * @returns {Promise<string>}
   * @param imgType {string} `gif` or `img`
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.neko('img').then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  neko: <T extends keyof SFWCategories>(imgType: T): Promise<string> => get(imgType, false, 'neko'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.okami().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  okami: (): Promise<string> => get('img', false, 'okami'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.senko().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  senko: (): Promise<string> => get('img', false, 'senko'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.shiro().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  shiro: (): Promise<string> => get('img', false, 'shiro'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.bite().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  bite: (): Promise<string> => get('gif', false, 'bite'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.blush().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  blush: (): Promise<string> => get('gif', false, 'blush'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.comfy().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  comfy: (): Promise<string> => get('gif', false, 'comfy'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.cry().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  cry: (): Promise<string> => get('gif', false, 'cry'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.cuddle().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  cuddle: (): Promise<string> => get('gif', false, 'cuddle'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.dance().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  dance: (): Promise<string> => get('gif', false, 'dance'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.fluff().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  fluff: (): Promise<string> => get('gif', false, 'fluff'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.hug().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  hug: (): Promise<string> => get('gif', false, 'hug'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.kiss().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  kiss: (): Promise<string> => get('gif', false, 'kiss'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.lick().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  lick: (): Promise<string> => get('gif', false, 'lick'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.pat().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  pat: (): Promise<string> => get('gif', false, 'pat'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.poke().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  poke: (): Promise<string> => get('gif', false, 'poke'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.slap().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  slap: (): Promise<string> => get('gif', false, 'slap'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.smile().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  smile: (): Promise<string> => get('gif', false, 'smile'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.tail().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  tail: (): Promise<string> => get('gif', false, 'tail'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.tickle().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  tickle: (): Promise<string> => get('gif', false, 'tickle'),
  /**
   * @returns {Promise<string>}
   * @example
   * import PurrBot from 'purrbot-api';
   * PurrBot.sfw.categories.lay().then(console.log);
   * // => https://purrbot.site/img/xxx.jpg
   */
  lay: (): Promise<string> => get('gif', false, 'lay'),
 },
};