Class MalAnimeOperation

MalAnimeOperation is the REST operation adapter for MyAnimeList anime endpoints.

It extends RestOperation and is composed into MyAnimeListApi via buildMyAnimeListApi, exposing MalAnime through MalRequestOptions and MyAnimeListAnimeApi.get. The discovery reads seasonal, ranking, and suggestions cover the seasonal, ranking, and suggestion endpoints.

See

Hierarchy (View Summary)

RestOperation
- MalAnimeOperation

Index

Constructors

constructor

Methods

deleteFromList get ranking search seasonal suggestions updateMyListStatus

Constructors

constructor

new MalAnimeOperation(
    authToken?: RequestAuthInput,
    options?: RequestOptions,
    stateOwner?: object,
): MalAnimeOperation
Constructs a new BaseOperation instance.
Parameters
- OptionalauthToken: RequestAuthInput
  The authentication material used for API requests. A string is treated as a bearer token for backwards compatibility.
- Optionaloptions: RequestOptions
  Transport settings scoped to this instance (timeout, cancellation, retry policy, lifecycle hooks).
- OptionalstateOwner: object
  Stable object keying cross-request transport state (circuit breaker, retry budget, pacing deadlines). Provider wirings pass one shared owner to every operation they construct so that state spans the whole client; when omitted, a fresh per-instance object is used and the state stays scoped to this operation.
Returns MalAnimeOperation
Inherited from RestOperation.constructor
- Defined in base/BaseOperation.ts:94

Methods

deleteFromList

deleteFromList(
params: MalAnimeDeleteParams,
options?: MalRequestOptions,
): Promise<void>
MalAnimeOperation.deleteFromList removes an anime from the authenticated user's list.

It calls DELETE /anime/{id}/my_list_status through RestOperation.execute with requiresAuth and resolves with no body. The facade alias is MyAnimeListAnimeApi.deleteFromList and it requires MalCredentials.accessToken.
Parameters
- params: MalAnimeDeleteParams
  The delete inputs; a MalAnimeDeleteParams carrying the MyAnimeList anime ID.
- options: MalRequestOptions = {}
  Optional transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<void>
Resolves once the entry is deleted; the response carries no body.
Throws
An AniLinkAuthError without an access token, or a normalized request error.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
await api.anime.deleteFromList({ id: 21 });
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/user-animelist/operation/anime_anime_id_my_list_status_delete
- Defined in apis/rest/mal/operations/AnimeOperation.ts:338

get

get(params: MalAnimeGetParams, options?: MalRequestOptions): Promise<MalAnime>
MalAnimeOperation.get gets one anime by its MyAnimeList ID.

It calls GET /anime/{id} through RestOperation.execute and returns a MalAnime shaped by MalRequestOptions.fields; when fields is omitted it falls back to DEFAULT_MAL_ANIME_FIELDS. The facade alias is MyAnimeListAnimeApi.get.
Parameters
- params: MalAnimeGetParams
  The anime lookup inputs; a MalAnimeGetParams carrying the MyAnimeList anime ID.
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalAnime>
The requested MalAnime.
Throws
A normalized AniLinkError when the request fails.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const anime = await api.anime.get({ id: 21 }, { fields: ["id", "title"] });
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/anime/operation/anime_anime_id_get
- Defined in apis/rest/mal/operations/AnimeOperation.ts:68

ranking

ranking(
params: MalRankingParams,
options?: MalRequestOptions,
): Promise<MalAnimeRankingResponse>
MalAnimeOperation.ranking gets one of MyAnimeList's anime ranking lists.

It calls GET /anime/ranking through RestOperation.execute with the ranking_type query parameter and returns a MalAnimeRankingResponse page of MalRankingEntry entries shaped by MalRequestOptions.fields. The facade exposes this method as MyAnimeListAnimeApi.ranking. It does not require an access token.
Parameters
- params: MalRankingParams
  The ranking read inputs; a MalRankingParams carrying the ranking list to fetch.
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalAnimeRankingResponse>
The ranking page, a MalAnimeRankingResponse.
Throws
A normalized AniLinkError when the request fails.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const top = await api.anime.ranking(
  { rankingType: "airing" },
  { fields: ["id", "title", "mean"] }
);
console.log(top.data[0]?.node.title, top.data[0]?.ranking.rank);
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/anime/operation/anime_ranking_get
- Defined in apis/rest/mal/operations/AnimeOperation.ts:196

search

search(
params: MalAnimeSearchParams,
options?: MalRequestOptions,
): Promise<MalAnimeSearchResponse>
MalAnimeOperation.search searches MyAnimeList anime by keyword.

It calls GET /anime through RestOperation.execute with the q keyword plus the limit/offset paging filters and returns a MalAnimeSearchResponse page of MalAnimeSearchEntry entries shaped by MalRequestOptions.fields. The facade exposes this method as MyAnimeListAnimeApi.search. It does not require an access token.
Parameters
- params: MalAnimeSearchParams
  The search inputs; a MalAnimeSearchParams carrying the keyword plus the optional paging filters.
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalAnimeSearchResponse>
The search results page, a MalAnimeSearchResponse.
Throws
An AniLinkValidationError when q is empty or only whitespace.

Throws
A normalized AniLinkError when the request fails.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const results = await api.anime.search(
  { q: "one piece" },
  { fields: ["id", "title", "main_picture"] }
);
console.log(results.data[0]?.node.title);
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/anime/operation/anime_get
- Defined in apis/rest/mal/operations/AnimeOperation.ts:108

seasonal

seasonal(
params: MalSeasonalParams,
options?: MalRequestOptions,
): Promise<MalSeasonalAnimeResponse>
MalAnimeOperation.seasonal gets the anime of one broadcast season.

It calls GET /anime/season/{year}/{season} through RestOperation.execute and returns a MalSeasonalAnimeResponse page of MalSeasonalAnime entries shaped by MalRequestOptions.fields. The facade exposes this method as MyAnimeListAnimeApi.seasonal. It does not require an access token.
Parameters
- params: MalSeasonalParams
  The seasonal read inputs; a MalSeasonalParams carrying the year and broadcast window.
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalSeasonalAnimeResponse>
The seasonal anime page, a MalSeasonalAnimeResponse.
Throws
A normalized AniLinkError when the request fails.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const season = await api.anime.seasonal(
  { year: 2024, season: "winter" },
  { fields: ["id", "title", "main_picture"] }
);
console.log(season.data[0]?.node.title);
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/anime/operation/anime_season_year_season_get
- Defined in apis/rest/mal/operations/AnimeOperation.ts:157

suggestions

suggestions(options?: MalRequestOptions): Promise<MalAnimeSuggestionsResponse>
MalAnimeOperation.suggestions gets MyAnimeList's anime suggestions for the authenticated user.

It calls GET /anime/suggestions through RestOperation.execute with requiresAuth and returns a MalAnimeSuggestionsResponse page of MalSuggestion entries shaped by MalRequestOptions.fields. The facade alias is MyAnimeListAnimeApi.suggestions and it requires MalCredentials.accessToken.
Parameters
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalAnimeSuggestionsResponse>
The suggestions page, a MalAnimeSuggestionsResponse.
Throws
An AniLinkAuthError without an access token, or a normalized request error.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const suggestions = await api.anime.suggestions({
  fields: ["id", "title", "main_picture"],
});
console.log(suggestions.data[0]?.node.title);
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/anime/operation/anime_suggestions_get
- Defined in apis/rest/mal/operations/AnimeOperation.ts:231

updateMyListStatus

updateMyListStatus(
params: MalAnimeListStatusUpdateParams,
options?: MalRequestOptions,
): Promise<MalAnimeListStatus>
MalAnimeOperation.updateMyListStatus updates the authenticated user's anime list status.

It calls PATCH /anime/{id}/my_list_status through RestOperation.execute with requiresAuth and a form-urlencoded MalAnimeListStatusUpdate body (the endpoint's documented request format), returning the updated MalAnimeListStatus. The facade alias is MyAnimeListAnimeApi.updateMyListStatus and it requires MalCredentials.accessToken.
Parameters
- params: MalAnimeListStatusUpdateParams
  The list-status write inputs; a MalAnimeListStatusUpdateParams carrying the anime ID plus only the fields to change.
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalAnimeListStatus>
The updated MalAnimeListStatus.
Throws
An AniLinkAuthError without an access token, an AniLinkValidationError when params carries no list-status field to change, or a normalized request error.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const status = await api.anime.updateMyListStatus({
  id: 21,
  status: "watching",
  num_watched_episodes: 10,
  score: 9,
});
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/user-animelist/operation/anime_anime_id_my_list_status_put
- Defined in apis/rest/mal/operations/AnimeOperation.ts:293

Class MalAnimeOperation

See

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MalAnimeOperation

Methods

deleteFromList

Parameters

Returns Promise<void>

Throws

Example

See

get

Parameters

Returns Promise<MalAnime>

Throws

Example

See

ranking

Parameters

Returns Promise<MalAnimeRankingResponse>

Throws

Example

See

search

Parameters

Returns Promise<MalAnimeSearchResponse>

Throws

Throws

Example

See

seasonal

Parameters

Returns Promise<MalSeasonalAnimeResponse>

Throws

Example

See

suggestions

Parameters

Returns Promise<MalAnimeSuggestionsResponse>

Throws

Example

See

updateMyListStatus

Parameters

Returns Promise<MalAnimeListStatus>

Throws

Example

See

Settings

On This Page