Class Favorites

Hierarchy (View Summary)

Base
- Favorites

Index

Constructors

Methods

create delete search

Constructors

constructor

new Favorites(e621: E621, client: Client): Favorites
Parameters
- e621: E621
- client: Client
Returns Favorites
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:20

Methods

create

create(post_id: number): Promise<FavoritesCreateResponse>
Requires Api Key Auth
Create Favorite
Parameters
- post_id: number
Returns Promise<FavoritesCreateResponse>

Operation Id
favorites#create

See
Documentation for more details.
- Defined in lib/modules/Favorites.ts:28

delete

delete(id: number): Promise<FavoritesDestroyResponse>
Requires Api Key Auth
Delete Favorite
Parameters
- id: number
Returns Promise<FavoritesDestroyResponse>

Operation Id
favorites#destroy

See
Documentation for more details.
- Defined in lib/modules/Favorites.ts:45

search

search<const O extends SearchFavoritesOptions = NoV2Options>(
options?: O,
): Promise<PostFormat<O["v2"], O["mode"]>[]>
Favorites Index
Type Parameters
- const O extends SearchFavoritesOptions = NoV2Options
Parameters
- Optionaloptions: O
Returns Promise<PostFormat<O["v2"], O["mode"]>[]>

Operation Id
favorites#index

See
Documentation for more details.
- Defined in lib/modules/Favorites.ts:60