Class WaifuClient

constructor

• new WaifuClient(options?): WaifuClient

• Parameters

  • Optional options: WaifuClientOptions

  Returns WaifuClient

Optional token

userAgent

deleteFavorite

• deleteFavorite(image_id, user_id?): Promise<FavoriteStatus>

• Removes an image from the user

  Parameters

  • image_id: number

    The ID of the image to insert.
  • Optional user_id: number

    The user ID of the user whose favorites you want to edit. Defaults to token's owner.

  Returns Promise<FavoriteStatus>

getFavorites

• getFavorites(query?, userId?): Promise<Image[]>

• Get your favorites. By default, this endpoint returns all images in the user favorites, meaning it will also returns lewd images if there are some in the user favorites.

  Parameters

  • Optional query: SearchQuery

    Search query options.
  • Optional userId: number

  Returns Promise<Image[]>

  Array of images.

getTags

• getTags(full): Promise<Tags<Tag>>

• Get full tag information.

  Parameters

  • full: true

  Returns Promise<Tags<Tag>>
• getTags(full): Promise<Tags<string>>

• Get list of available tags.

  Parameters

  • full: false

  Returns Promise<Tags<string>>
• getTags(full): Promise<Tags<Tag> | Tags<string>>

• Gets the list of available tags.

  Parameters

  • full: boolean

    Whether to return full tag information.

  Returns Promise<Tags<Tag> | Tags<string>>

insertFavorite

• insertFavorite(image_id, user_id?): Promise<FavoriteStatus>

• Inserts an image into the user

  Parameters

  • image_id: number

    The ID of the image to insert.
  • Optional user_id: number

    The user ID of the user whose favorites you want to edit. Defaults to token's owner.

  Returns Promise<FavoriteStatus>

reportImage

• reportImage(image_id, description): Promise<ImageReport>

• Reports an image. Used to report any inappropriate, offensive or wrongly labelled image in the API. Requires report permission.

  Parameters

  • image_id: number

    The ID of the image to report.
  • description: string

    A brief explanation (up to 200 characters) used to describe the issue.

  Returns Promise<ImageReport>

search

• search(query?): Promise<Image[]>

• Search images. Retrieves images randomly or by tag based on the specified search criteria.

  Parameters

  • Optional query: SearchQuery

    Search query options.

  Returns Promise<Image[]>

  Array of images.

toggleFavorite

• toggleFavorite(image_id, user_id?): Promise<FavoriteStatus>

• Toggles an image in the user

  Parameters

  • image_id: number

    The ID of the image to insert.
  • Optional user_id: number

    The user ID of the user whose favorites you want to edit. Defaults to token's owner.

  Returns Promise<FavoriteStatus>