Class WaifuClient

constructor

• new WaifuClient(options?: WaifuClientOptions): WaifuClient

  Parameters

  • Optionaloptions: WaifuClientOptions

  Returns WaifuClient

albums

artists

auth

images

reports

stats

storageDiff

tags

users

authenticated

• get authenticated(): boolean

  Whether the client instance is authenticated by specifying an API key or JWT token.

  Returns boolean

authenticate

• authenticate(auth: WaifuAuth): void

  Sets authentication options, using either an API key or a JWT.

  See AuthenticationService#loginDiscord for JWT.

  Parameters

  • auth: WaifuAuth

  Returns void

  Throws

  If both apiKey and jwt is passed. Use one.

clearAuthentication

• clearAuthentication(): void

  Removes any authentication option provided previously.

  Returns void

request

• request<T>(endpoint: string, options?: RequestOptions): Promise<T>
  Internal

  Performs an API HTTP request, not intended for public use.

  Type Parameters

  • T

  Parameters

  • endpoint: string
  • Optionaloptions: RequestOptions

  Returns Promise<T>

  Throws

  ApiError if the response status code is not 200