Class Users

Hierarchy

Users

Index

Constructors

Methods

getUserAbout getUserById getUserClubs getUserExternal getUserFavorites getUserFriends getUserFullProfile getUserHistory getUserProfile getUserRecommendations getUserReviews getUserStatistics getUserUpdates getUsersSearch

Constructors

constructor

new Users(cacheOptions?): Users
Constructs an instance of the users client
Parameters
- Optional cacheOptions: CacheOptions
  
  Cache options for the client to make requests
Returns Users
- Defined in lib/jikan/users.ts:28

Methods

getUserAbout

getUserAbout(username): Promise<IUserAbout>
Gets the about of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
Returns Promise<IUserAbout>
About of the user
- Defined in lib/jikan/users.ts:115

getUserById

getUserById(id): Promise<IUserById>
Gets the URL & username of a user from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the user
Returns Promise<IUserById>
The URL & username of the user
- Defined in lib/jikan/users.ts:49

getUserClubs

getUserClubs(username, config?): Promise<{
data: IUserClub[];
pagination: IPagination;
}>
Gets the list of clubs of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
- Optional config: ICommonConfig
  
  Config to make the request
Returns Promise<{
data: IUserClub[];
pagination: IPagination;
}>
The list of clubs of the user
- Defined in lib/jikan/users.ts:194

getUserExternal

getUserExternal(username): Promise<IResource[]>
Gets the external sites of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
Returns Promise<IResource[]>
The external sites of the user
- Defined in lib/jikan/users.ts:210

getUserFavorites

getUserFavorites(username): Promise<IUserFavorites>
Gets the list of favorites of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
Returns Promise<IUserFavorites>
List of favorites of the user
- Defined in lib/jikan/users.ts:93

getUserFriends

getUserFriends(username, config?): Promise<{
data: IUserFriend[];
pagination: IPagination;
}>
Gets the list of friends of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
- Optional config: ICommonConfig
  
  Config to make the request
Returns Promise<{
data: IUserFriend[];
pagination: IPagination;
}>
The list of friends of the user
- Defined in lib/jikan/users.ts:143

getUserFullProfile

getUserFullProfile(username): Promise<IUserFull>
Gets the full profile of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
Returns Promise<IUserFull>
The full profile of the user
- Defined in lib/jikan/users.ts:60

getUserHistory

getUserHistory(username, config?): Promise<IUserHistory[]>
Gets the list of histories of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
- Optional config: IUserHistoryConfig
  
  Config to make the request
Returns Promise<IUserHistory[]>
The list of histories of the user
- Defined in lib/jikan/users.ts:127

getUserProfile

getUserProfile(username): Promise<IUserProfile>
Gets the profile of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
Returns Promise<IUserProfile>
The profile of the user
- Defined in lib/jikan/users.ts:71

getUserRecommendations

getUserRecommendations(username, config?): Promise<{
data: IRandomRecommendation[];
pagination: IPagination;
}>
Gets the list of recommendations posted by a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
- Optional config: ICommonConfig
  
  Config to make the request
Returns Promise<{
data: IRandomRecommendation[];
pagination: IPagination;
}>
The list of recommendations posted by the user
- Defined in lib/jikan/users.ts:177

getUserReviews

getUserReviews(username, config?): Promise<{
data: IUserReview[];
pagination: IPagination;
}>
Gets the list of reviews posted by a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
- Optional config: ICommonConfig
  
  Config to make the request
Returns Promise<{
data: IUserReview[];
pagination: IPagination;
}>
The list of reviews posted by the user
- Defined in lib/jikan/users.ts:160

getUserStatistics

getUserStatistics(username): Promise<{
    anime: IUserStatistics & {
        days_watched: number;
        episodes_watched: number;
        plan_to_watch: number;
        rewatched: number;
        watching: number;
    };
    manga: IUserStatistics & {
        chapters_read: number;
        days_read: number;
        plan_to_read: number;
        reading: number;
        reread: number;
        volumes_read: number;
    };
}>
Gets the statistics of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
Returns Promise<{
    anime: IUserStatistics & {
        days_watched: number;
        episodes_watched: number;
        plan_to_watch: number;
        rewatched: number;
        watching: number;
    };
    manga: IUserStatistics & {
        chapters_read: number;
        days_read: number;
        plan_to_read: number;
        reading: number;
        reread: number;
        volumes_read: number;
    };
}>
The statistics of the user
- Defined in lib/jikan/users.ts:82

getUserUpdates

getUserUpdates(username): Promise<IUserUpdatesResponse>
Gets the updates of a user from its MyAnimeList username
Parameters
- username: string
  
  Username of the user
Returns Promise<IUserUpdatesResponse>
The updates of the user
- Defined in lib/jikan/users.ts:104

getUsersSearch

getUsersSearch(config?): Promise<{
data: IUserBaseRes[];
pagination: IPagination;
}>
Searches for user in MyAnimeList
Parameters
- Optional config: IUserSearchConfig
  
  Config to make the search
Returns Promise<{
data: IUserBaseRes[];
pagination: IPagination;
}>
Results of the user search
- Defined in lib/jikan/users.ts:37

Class Users

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional cacheOptions: CacheOptions

Returns Users

Methods

getUserAbout

Parameters

username: string

Returns Promise<IUserAbout>

getUserById

Parameters

id: string | number

Returns Promise<IUserById>

getUserClubs

Parameters

username: string

Optional config: ICommonConfig

Returns Promise<{ data: IUserClub[]; pagination: IPagination; }>

getUserExternal

Parameters

username: string

Returns Promise<IResource[]>

getUserFavorites

Parameters

username: string

Returns Promise<IUserFavorites>

getUserFriends

Parameters

username: string

Optional config: ICommonConfig

Returns Promise<{ data: IUserFriend[]; pagination: IPagination; }>

getUserFullProfile

Parameters

username: string

Returns Promise<IUserFull>

getUserHistory

Parameters

username: string

Optional config: IUserHistoryConfig

Returns Promise<IUserHistory[]>

getUserProfile

Parameters

username: string

Returns Promise<IUserProfile>

getUserRecommendations

Parameters

username: string

Optional config: ICommonConfig

Returns Promise<{ data: IRandomRecommendation[]; pagination: IPagination; }>

getUserReviews

Parameters

username: string

Optional config: ICommonConfig

Returns Promise<{ data: IUserReview[]; pagination: IPagination; }>

getUserStatistics

Parameters

username: string

getUserUpdates

Parameters

username: string

Returns Promise<IUserUpdatesResponse>

getUsersSearch

Parameters

Optional config: IUserSearchConfig

Returns Promise<{ data: IUserBaseRes[]; pagination: IPagination; }>

Settings

Member Visibility

Theme

On This Page

`Optional` cacheOptions: CacheOptions

`Optional` config: ICommonConfig

Returns Promise<{
data: IUserClub[];
pagination: IPagination;
}>

`Optional` config: ICommonConfig

Returns Promise<{
data: IUserFriend[];
pagination: IPagination;
}>

`Optional` config: IUserHistoryConfig

`Optional` config: ICommonConfig

Returns Promise<{
data: IRandomRecommendation[];
pagination: IPagination;
}>

`Optional` config: ICommonConfig

Returns Promise<{
data: IUserReview[];
pagination: IPagination;
}>

`Optional` config: IUserSearchConfig

Returns Promise<{
data: IUserBaseRes[];
pagination: IPagination;
}>