User

AniList. User

Access AniList's user data.

Methods

all(user) → {Object}

Description:
  • Fetch a user's AniList profile, basic and stats.
Source:
Since:
  • 1.0.0
Parameters:
Name Type Description
user Number | String Required. Can either be the username or the AniList ID.
Returns:
Returns all keys within UserProfile and UserStats. UserStats are found under the statistics key.
Type
Object

(async) follow(userID) → {Boolean}

Description:
  • [Requires Login] Follow/Unfollow a user
Source:
Since:
  • 1.12.0
Parameters:
Name Type Description
userID Number The user ID of the account to follow
Returns:
True if following, false otherwise.
Type
Boolean

getAuthorized() → {UserProfile}

Description:
  • Fetch profile information on the currently authorized user.
Source:
Since:
  • 1.8.0
Returns:
Type
UserProfile

getRecentActivity(user) → {Array.<Object>}

Description:
  • Fetch recent activity from a user.
Source:
Since:
  • 1.6.0
Parameters:
Name Type Description
user Number Required. Needs to be the user's AniList ID.
Returns:
Returns the 25 most recent activities of the user. Contains any number of ListActivity, TextActivity, MessageActivity. All of which are identifyable by the type key.
Type
Array.<Object>

profile(user) → {UserProfile}

Description:
  • Fetch a user's AniList basic profile.
Source:
Since:
  • 1.0.0
Parameters:
Name Type Description
user Number | String Required. Can either be the username or the AniList ID.
Returns:
Type
UserProfile

stats(user) → {UserStats}

Description:
  • Fetch a user's AniList stats.
Source:
Since:
  • 1.3.0
Parameters:
Name Type Description
user Number | String Required. Can either be the username or the AniList ID.
Returns:
Type
UserStats

(async) update(options) → {UserOptions}

Description:
  • [Requires Login] Update user settings
Source:
Since:
  • 1.10.0
Parameters:
Name Type Description
options UserOptionsInput
Returns:
Type
UserOptions