Class NekosAPI

Hierarchy (view full)

Base
- NekosAPI

Index

Constructors

Properties

Methods

_getImages _getRandomImages fetchResponse getImage getImageByID getImages getRandomImage processSearchParams checkResponseCode

Constructors

constructor

new NekosAPI(proxy?): NekosAPI
Parameters
- Optional proxy: CustomProxy
Returns NekosAPI
Overrides Base.constructor
- Defined in src/v4/NekosAPI.ts:17

Properties

`Private` `Readonly` baseUrl

baseUrl: string

`Protected` `Optional` socks5Proxy

socks5Proxy?: CustomProxy

`Static` lastRequest

lastRequest: Date = ...

Methods

`Private` _getImages

_getImages(tags, options): Promise<NekosImage[]>
Parameters
- tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]
- options: FullImageOptions
Returns Promise<NekosImage[]>
- Defined in src/v4/NekosAPI.ts:34

`Private` _getRandomImages

_getRandomImages(tags?, options?): Promise<NekosImage[]>
Parameters
- Optional tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]
- Optional options: BaseImageOptions
Returns Promise<NekosImage[]>
- Defined in src/v4/NekosAPI.ts:46

`Protected` fetchResponse

fetchResponse<T>(url, config?): Promise<T>
Type Parameters
- T
Parameters
- url: URL
- Optional config: AxiosRequestConfig<any>
Returns Promise<T>
Inherited from Base.fetchResponse
- Defined in src/base.ts:15

getImage

getImage(tags?, options?): Promise<NekosImage>
Parameters
- Optional tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]
- Optional options: BaseImageOptions
Returns Promise<NekosImage>
- Defined in src/v4/NekosAPI.ts:24

getImageByID

getImageByID(id): Promise<NekosImage>
Parameters
- id: string | number
Returns Promise<NekosImage>
- Defined in src/v4/NekosAPI.ts:53

getImages

getImages(tags?, options?): Promise<NekosImage[]>
Parameters
- Optional tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]
- Optional options: FullImageOptions
Returns Promise<NekosImage[]>
- Defined in src/v4/NekosAPI.ts:30

getRandomImage

getRandomImage(tags?, options?): Promise<NekosImage>
Parameters
- Optional tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]
- Optional options: BaseImageOptions
Returns Promise<NekosImage>
- Defined in src/v4/NekosAPI.ts:41

`Private` processSearchParams

processSearchParams(url, tags, options): URL
Parameters
- url: URL
- tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]
- options: FullImageOptions
Returns URL
- Defined in src/v4/NekosAPI.ts:58

`Static` `Protected` checkResponseCode

checkResponseCode<T>(response): Promise<void>
Type Parameters
- T
Parameters
- response: AxiosResponse<T, any>
Returns Promise<void>
Inherited from Base.checkResponseCode
- Defined in src/base.ts:45

Class NekosAPI

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional proxy: CustomProxy

Returns NekosAPI

Properties

Private Readonly baseUrl

Protected Optional socks5Proxy

Static lastRequest

Methods

Private _getImages

Parameters

options: FullImageOptions

Returns Promise<NekosImage[]>

Private _getRandomImages

Parameters

Optional options: BaseImageOptions

Returns Promise<NekosImage[]>

Protected fetchResponse

Type Parameters

T

Parameters

url: URL

Optional config: AxiosRequestConfig<any>

Returns Promise<T>

getImage

Parameters

Optional options: BaseImageOptions

Returns Promise<NekosImage>

getImageByID

Parameters

id: string | number

Returns Promise<NekosImage>

getImages

Parameters

Optional options: FullImageOptions

Returns Promise<NekosImage[]>

getRandomImage

Parameters

Optional options: BaseImageOptions

Returns Promise<NekosImage>

Private processSearchParams

Parameters

url: URL

options: FullImageOptions

Returns URL

Static Protected checkResponseCode

Type Parameters

T

Parameters

response: AxiosResponse<T, any>

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` proxy: CustomProxy

`Private` `Readonly` baseUrl

`Protected` `Optional` socks5Proxy

`Static` lastRequest

`Private` _getImages

`Private` _getRandomImages

`Optional` options: BaseImageOptions

`Protected` fetchResponse

`Optional` config: AxiosRequestConfig<any>

`Optional` options: BaseImageOptions

`Optional` options: FullImageOptions

`Optional` options: BaseImageOptions

`Private` processSearchParams

`Static` `Protected` checkResponseCode