Class Favorites<PF>

constructor

• new Favorites<PF extends PostFormatOptions = NoV2Options>(
      e621: E621<PF> | undefined,
      client: Client,
      defaultFormat?: PF,
  ): Favorites<PF>

  Type Parameters

  • PF extends PostFormatOptions = NoV2Options

  Parameters

  • e621: E621<PF> | undefined
  • client: Client
  • defaultFormat: PF = ...

    The v2/mode format to fall back to when search() is called without explicit v2/mode options.

  Returns Favorites<PF>

Static ReadonlymoduleKey

create

• create(post_id: number): Promise<FavoritesCreateResponse>
  Requires Api Key Auth

  Parameters

  • post_id: number

  Returns Promise<FavoritesCreateResponse>

  Operation Id

  favorites#create

  See

  Documentation for more details.

delete

• delete(id: number): Promise<FavoritesDestroyResponse>
  Requires Api Key Auth

  Parameters

  • id: number

  Returns Promise<FavoritesDestroyResponse>

  Operation Id

  favorites#destroy

  See

  Documentation for more details.

search

• search<const O extends SearchFavoritesOptions = PF>(
      options?: O,
  ): Promise<PostFormat<O["v2"], O["mode"], PF>[]>

  Type Parameters

  • const O extends SearchFavoritesOptions = PF

  Parameters

  • Optionaloptions: O

  Returns Promise<PostFormat<O["v2"], O["mode"], PF>[]>

  Operation Id

  favorites#index

  See

  Documentation for more details.