Class API

Hierarchy

API

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new API(data: PixivAuthData, headers: PixivAuthHeaders, refreshToken: string, accessToken: string, loginTime: number, expirationTime: number): API

- Defined in API.ts:12
Parameters
- data: PixivAuthData
- headers: PixivAuthHeaders
- refreshToken: string
- accessToken: string
- loginTime: number
- expirationTime: number
Returns API

Properties

Private accessToken

accessToken: string

Private data

data: PixivAuthData

Private expirationTime

expirationTime: number

Private headers

headers: PixivAuthHeaders

Private loginTime

loginTime: number

Private refreshToken

refreshToken: string

Methods

destructureParams

destructureParams(nextUrl: string): object

- Defined in API.ts:64
Destructures a URL to get all of the search parameters and values.

Parameters
- nextUrl: string
Returns object
- baseUrl: string
- params: PixivParams

get

get(endpoint: string, params?: PixivParams): Promise<any>

- Defined in API.ts:40
Fetches an endpoint from the API and returns the response.

Parameters
- endpoint: string
- Optional params: PixivParams
Returns Promise<any>

next

next(nextUrl: string): Promise<any>

- Defined in API.ts:53
Fetches the url in the nextUrl() property of search responses.

Parameters
- nextUrl: string
Returns Promise<any>

refreshAccessToken

refreshAccessToken(refreshToken?: string): Promise<string>

- Defined in API.ts:23
Gets a new access token if the refresh token expires.

Parameters
- Optional refreshToken: string
Returns Promise<string>

Generated using TypeDoc