Class NekosAPIv1

Hierarchy (view full)

Base
- NekosAPIv1

Index

Constructors

Properties

baseUrl socks5Proxy? token lastRequest tokenRegex

Methods

_getRandomImages fetchResponse getArtistByID getCategories getCategoryByID getCharacterByID getImageByID getImages getImagesByArtistID getRandomImage getRandomImages checkResponseCode validateToken

Constructors

constructor

new NekosAPIv1(token?, proxy?): NekosAPIv1
Parameters
- Optional token: string
- Optional proxy: CustomProxy
Returns NekosAPIv1
Overrides Base.constructor
- Defined in src/v1/NekosAPI.ts:17

Properties

`Private` `Readonly` baseUrl

baseUrl: string

`Protected` `Optional` socks5Proxy

socks5Proxy?: CustomProxy

`Private` `Readonly` token

token: string

`Static` lastRequest

lastRequest: Date = ...

`Static` `Private` tokenRegex

tokenRegex: RegExp = ...

Methods

`Private` _getRandomImages

_getRandomImages(categories?, limit?): Promise<NekosImage[]>
Parameters
- Optional categories: string | string[]
- Optional limit: number
Returns Promise<NekosImage[]>
- Defined in src/v1/NekosAPI.ts:59

`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

getArtistByID

getArtistByID(id): Promise<Artist>
Parameters
- id: string
Returns Promise<Artist>
- Defined in src/v1/NekosAPI.ts:91

getCategories

getCategories(limit?, offset?): Promise<Category[]>
Parameters
- limit: number = 10
- offset: number = 0
Returns Promise<Category[]>
- Defined in src/v1/NekosAPI.ts:125

getCategoryByID

getCategoryByID(categoryID): Promise<Category>
Parameters
- categoryID: string
Returns Promise<Category>
- Defined in src/v1/NekosAPI.ts:138

getCharacterByID

getCharacterByID(id): Promise<Character>
Parameters
- id: string
Returns Promise<Character>
- Defined in src/v1/NekosAPI.ts:115

getImageByID

getImageByID(id): Promise<NekosImage>
Parameters
- id: string
Returns Promise<NekosImage>
- Defined in src/v1/NekosAPI.ts:81

getImages

getImages(limit?, offset?): Promise<NekosImage[]>
Parameters
- limit: number = 10
- offset: number = 0
Returns Promise<NekosImage[]>
- Defined in src/v1/NekosAPI.ts:27

getImagesByArtistID

getImagesByArtistID(id, limit?, offset?): Promise<NekosImage[]>
Parameters
- id: string
- limit: number = 10
- offset: number = 0
Returns Promise<NekosImage[]>
- Defined in src/v1/NekosAPI.ts:101

getRandomImage

getRandomImage(categories?): Promise<NekosImage>
Parameters
- Optional categories: string | string[]
Returns Promise<NekosImage>
- Defined in src/v1/NekosAPI.ts:55

getRandomImages

getRandomImages(categories?, limit?): Promise<NekosImage[]>
Parameters
- Optional categories: string | string[]
- Optional limit: number
Returns Promise<NekosImage[]>
- Defined in src/v1/NekosAPI.ts:50

`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

`Static` `Private` validateToken

validateToken(token?): boolean
Parameters
- Optional token: string
Returns boolean
- Defined in src/v1/NekosAPI.ts:146

Generated using TypeDoc