Class MalUserOperation

MalUserOperation is the REST operation adapter for the MyAnimeList user endpoints.

It extends RestOperation and is composed into MyAnimeListApi via buildMyAnimeListApi, exposing MalUser through MalRequestOptions and MyAnimeListUserApi.me. The paginated user-list reads animeList and mangaList cover GET /users/{user_name}/animelist and GET /users/{user_name}/mangalist.

See

Hierarchy (View Summary)

RestOperation
- MalUserOperation

Index

Constructors

constructor

Methods

animeList get mangaList me

Constructors

constructor

new MalUserOperation(
    authToken?: RequestAuthInput,
    options?: RequestOptions,
    stateOwner?: object,
): MalUserOperation
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 MalUserOperation
Inherited from RestOperation.constructor
- Defined in base/BaseOperation.ts:94

Methods

animeList

animeList(
params: MalUserAnimeListParams,
options?: MalRequestOptions,
): Promise<MalUserAnimeListResponse>
MalUserOperation.animeList gets a user's anime list, one page at a time.

It calls GET /users/{username}/animelist through RestOperation.execute and returns a MalUserAnimeListResponse page of MalUserAnimeListEntry entries shaped by MalRequestOptions.fields. The facade exposes this method as MyAnimeListUserApi.animeList. username accepts a user name or @me; @me and private lists require an access token. The @me check ignores case and surrounding whitespace.
Parameters
- params: MalUserAnimeListParams
  The anime-list read inputs; a MalUserAnimeListParams carrying the username plus the optional status, sort, and paging filters.
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalUserAnimeListResponse>
The anime list page, a MalUserAnimeListResponse.
Throws
An AniLinkAuthError when username is @me and no access token is configured.

Throws
An AniLinkValidationError when username is empty or only whitespace.

Throws
A normalized AniLinkError when the request fails.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const list = await api.user.animeList(
  { username: "@me", status: "watching" },
  { fields: ["id", "title", "list_status"] }
);
console.log(list.data[0]?.node.title);
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/user-animelist/operation/users_user_id_animelist_get
- Defined in apis/rest/mal/operations/UserOperation.ts:158

get

get(params: MalUserGetParams, options?: MalRequestOptions): Promise<MalUser>
MalUserOperation.get gets a MyAnimeList user profile.

It calls GET /users/{username} through RestOperation.execute and returns a MalUser shaped by MalRequestOptions.fields. The facade alias is MyAnimeListUserApi.get. MyAnimeList documents only @me for this endpoint, so username accepts @me (with the same case-insensitive, whitespace-tolerant check as the user-list reads) and requires an access token to resolve it. Other usernames are passed through, but MyAnimeList currently answers them with 404.
Parameters
- params: MalUserGetParams
  The profile read inputs; a MalUserGetParams carrying the username.
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalUser>
The requested MalUser.
Throws
An AniLinkAuthError when no access token is configured.

Throws
An AniLinkValidationError when username is empty or only whitespace.

Throws
A normalized AniLinkError when the request fails.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const user = await api.user.get(
  { username: "@me" },
  { fields: ["id", "name", "location"] }
);
console.log(user.name);
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/users/operation/users_user_id_get
- Defined in apis/rest/mal/operations/UserOperation.ts:104

mangaList

mangaList(
params: MalUserMangaListParams,
options?: MalRequestOptions,
): Promise<MalUserMangaListResponse>
MalUserOperation.mangaList gets a user's manga list, one page at a time.

It calls GET /users/{username}/mangalist through RestOperation.execute and returns a MalUserMangaListResponse page of MalUserMangaListEntry entries shaped by MalRequestOptions.fields. The facade exposes this method as MyAnimeListUserApi.mangaList. username accepts a user name or @me; @me and private lists require an access token. The @me check ignores case and surrounding whitespace.
Parameters
- params: MalUserMangaListParams
  The manga-list read inputs; a MalUserMangaListParams carrying the username plus the optional status, sort, and paging filters.
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalUserMangaListResponse>
The manga list page, a MalUserMangaListResponse.
Throws
An AniLinkAuthError when username is @me and no access token is configured.

Throws
An AniLinkValidationError when username is empty or only whitespace.

Throws
A normalized AniLinkError when the request fails.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const list = await api.user.mangaList(
  { username: "@me", status: "reading" },
  { fields: ["id", "title", "list_status"] }
);
console.log(list.data[0]?.node.title);
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/user-mangalist/operation/users_user_id_mangalist_get
- Defined in apis/rest/mal/operations/UserOperation.ts:218

me

me(options?: MalRequestOptions): Promise<MalUser>
MalUserOperation.me gets the currently authenticated MyAnimeList user.

It calls GET /users/@me through RestOperation.execute with requiresAuth and returns a MalUser shaped by MalRequestOptions.fields. The facade alias is MyAnimeListUserApi.me and it requires MalCredentials.accessToken.
Parameters
- options: MalRequestOptions = {}
  Optional field selection and transport settings; a MalRequestOptions merged over the instance defaults.
Returns Promise<MalUser>
The authenticated MalUser.
Throws
An AniLinkAuthError without an access token, or a normalized request error.
Example
```
const api = new AniLink({ mal: { accessToken: "mal-token" } }).mal;
const user = await api.user.me({ fields: ["id", "name"] });
```
See
https://myanimelist.net/apiconfig/references/api/v2#tag/users/operation/users_user_id_get
- Defined in apis/rest/mal/operations/UserOperation.ts:65

Class MalUserOperation

See

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MalUserOperation

Methods

animeList

Parameters

Returns Promise<MalUserAnimeListResponse>

Throws

Throws

Throws

Example

See

get

Parameters

Returns Promise<MalUser>

Throws

Throws

Throws

Example

See

mangaList

Parameters

Returns Promise<MalUserMangaListResponse>

Throws

Throws

Throws

Example

See

me

Parameters

Returns Promise<MalUser>

Throws

Example

See

Settings

On This Page