Options
All
  • Public
  • Public/Protected
  • All
Menu

Class API

Hierarchy

  • API

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Properties

accessToken

accessToken: string

Private authHeaders

authHeaders: PixivAuthHeaders

Private data

data: PixivAuthData

Private expirationTime

expirationTime: number

Private loginTime

loginTime: number

refreshToken

refreshToken: string

Methods

destructureParams

  • destructureParams(nextUrl: string): object

  • Destructures a URL to get all of the search parameters and values.

    Parameters

    • nextUrl: string

    Returns object

get

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

  • Fetches an endpoint from the API and returns the response.

    Parameters

    Returns Promise<any>

getWeb

  • Fetches from web url and returns the response.

    Parameters

    Returns Promise<any>

next

  • next(nextUrl: string): Promise<any>

  • Fetches the url in the nextUrl() property of search responses.

    Parameters

    • nextUrl: string

    Returns Promise<any>

post

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

  • Post with the API and returns the response.

    Parameters

    Returns Promise<any>

refreshAccessToken

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

  • Gets a new access token if the refresh token expires.

    Parameters

    • Optional refreshToken: string

    Returns Promise<string>

request

  • request(baseUrl: string, params?: any): Promise<any>

  • Fetches any url.

    Parameters

    • baseUrl: string
    • Optional params: any

    Returns Promise<any>

Object literals

Private headers

headers: object

accept-language

accept-language: string = "English"

referer

referer: string = "https://www.pixiv.net/"

user-agent

user-agent: string = "PixivIOSApp/7.7.5 (iOS 13.2.0; iPhone XR)"

Generated using TypeDoc