shiro.gg/comp/endpoints/sfw.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 };