shiro.gg/comp/endpoints/sfw_camel.d.ts

An api wrapper for shiro.gg

import { ImageResult } from './../typings';
/**
 * Get a random avatar
 *
 * @returns {Promise} An avatar image
 * @example
 * ```js
 * shiro.avatar().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const avatar: () => Promise<ImageResult>;
/**
 * Get a random avatar
 *
 * @returns {Promise} An avatar image
 * @example
 * ```js
 * shiro.avatars().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const avatars: () => Promise<ImageResult>;
/**
 * Get an image / gif of blushing
 *
 * @returns {Promise} A blushing image or gif
 * @example
 * ```js
 * shiro.blush().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const blush: () => Promise<ImageResult>;
/**
 * Get an image / gif of crying
 *
 * @returns {Promise} A crying gif
 * @example
 * ```js
 * shiro.cry().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const cry: () => Promise<ImageResult>;
/**
 * Get a gif of hugging
 *
 * @returns {Promise} A hugging image / gif
 * @example
 * ```js
 * shiro.hug().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const hug: () => Promise<ImageResult>;
/**
 * Get a gif of kissing
 *
 * @returns {Promise} A kissing gif
 * @example
 * ```js
 * shiro.kiss().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const kiss: () => Promise<ImageResult>;
/**
 * Get a gif of licking
 *
 * @returns {Promise} A licking gif
 * @example
 * ```js
 * shiro.lick().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const lick: () => Promise<ImageResult>;
/**
 * Get an image of neko / catgirl
 *
 * @returns {Promise} An image of catgirl
 * @example
 * ```js
 * shiro.neko().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const neko: () => Promise<ImageResult>;
/**
 * Get a gif of eating
 *
 * @returns {Promise} An eating gif
 * @example
 * ```js
 * shiro.nom().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const nom: () => Promise<ImageResult>;
/**
 * Get a gif of patting
 *
 * @returns {Promise} A patting gif
 * @example
 * ```js
 * shiro.pat().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const pat: () => Promise<ImageResult>;
/**
 * Get a gif of poking
 *
 * @returns {Promise} A poking gif
 * @example
 * ```js
 * shiro.poke().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const poke: () => Promise<ImageResult>;
/**
 * Get a gif of pouting
 *
 * @returns {Promise} A pouting gif
 * @example
 * ```js
 * shiro.pout().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const pout: () => Promise<ImageResult>;
/**
 * Get a gif of punching
 *
 * @returns {Promise} A punching gif
 * @example
 * ```js
 * shiro.punch().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const punch: () => Promise<ImageResult>;
/**
 * Get a gif of slapping
 *
 * @returns {Promise} A slapping gif
 * @example
 * ```js
 * shiro.slap().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const slap: () => Promise<ImageResult>;
/**
 * Get a gif of sleeping
 *
 * @returns {Promise} A sleeping gif
 * @example
 * ```js
 * shiro.sleep().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const sleep: () => Promise<ImageResult>;
/**
 * Get a gif of smugging
 *
 * @returns {Promise} A smug image
 * @example
 * ```js
 * shiro.smug().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const smug: () => Promise<ImageResult>;
/**
 * Get a gif of tickling
 *
 * @returns {Promise} A tickling gif
 * @example
 * ```js
 * shiro.tickle().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const tickle: () => Promise<ImageResult>;
/**
 * Get a random image of a trap (Bot dressed as girl)
 *
 * @returns {Promise} An image of a trap
 * @example
 * ```js
 * shiro.trap().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const trap: () => Promise<ImageResult>;
/**
 * Get a random wallpaper
 *
 * @returns {Promise} A wallpaper
 * @example
 * ```js
 * shiro.wallpaper().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const wallpaper: () => Promise<ImageResult>;
/**
 * Get a random wallpaper
 *
 * @returns {Promise} A wallpaper
 * @example
 * ```js
 * shiro.wallpapers().then(res => {
 *     console.log(res)
 * })
 * ```
 *
 * @public
 */
declare const wallpapers: () => Promise<ImageResult>;
export { avatar, avatars, blush, cry, hug, kiss, lick, neko, nom, pat, poke, pout, punch, slap, sleep, smug, tickle, trap, wallpaper, wallpapers };