Class ToggleFavouriteMutation

ToggleFavouriteMutation is a class that contains the method to toggle a favourite. It includes a method to toggle a favourite.

See

https://docs.anilist.co/reference/mutation

Hierarchy (View Summary)

APIWrapper
- ToggleFavouriteMutation

Index

Constructors

Methods

toggleFavourite

Constructors

constructor

new ToggleFavouriteMutation(authToken?: string): ToggleFavouriteMutation
Constructs a new ToggleFavouriteMutation instance.
Parameters
- OptionalauthToken: string
  The authentication token.
Returns ToggleFavouriteMutation
Overrides APIWrapper.constructor
- Defined in apis/anilist/mutation/ToggleFavourite.ts:54

Methods

toggleFavourite

toggleFavourite(variables: ToggleFavouriteVariables): Promise<Favourites>
toggleFavourite is a method that sends a mutation request to toggle a favourite.
Parameters
- variables: ToggleFavouriteVariables
  An object of type ToggleFavouriteVariables representing the variables for the mutation.
Returns Promise<Favourites>
A Promise that resolves to the response from the mutation request.

Throws
Will throw an error if the mutation request fails or if the provided variables do not pass the validation checks.

See
https://docs.anilist.co/reference/mutation
- Defined in apis/anilist/mutation/ToggleFavourite.ts:67