AniList-Node Documentation

Constructor

new AniList(accessKeyopt, optionsopt)

Source:

index.js, line 15

Since:

1.0.0

Parameters:

Name	Type	Attributes	Description
`accessKey`	String	<optional>	The AniList API token. If no key is provided, the user will not be able to access private information such as the authorized user's profile (if set to private).
`options`	InitOptions	<optional>	Optional options to use when getting info from AniList

Classes

Activity
Lists
Media
People
Recommendation
Search
Thread
User

Members

activity

Source:

index.js, line 70

Since:

1.7.0

See:

AniList.Activity

lists

Source:

index.js, line 49

Since:

1.1.0

See:

AniList.Lists

media

Source:

index.js, line 56

Since:

1.0.0

See:

AniList.Media

people

Source:

index.js, line 63

Since:

1.0.0

See:

AniList.People

recommendation

Source:

index.js, line 84

Since:

1.8.0

See:

AniList.Recommendation

searchEntry

Source:

index.js, line 77

Since:

1.7.0

See:

AniList.Search

thread

Source:

index.js, line 91

Since:

1.11.0

See:

AniList.Thread

user

Source:

index.js, line 42

Since:

1.0.0

See:

AniList.User

Methods

(async) favouriteStudio(id) → {Boolean}

Description:

[Requires Login] Favourite/Unfavourite a studio

Source:

index.js, line 117

Since:

1.12.0

Parameters:

Name	Type	Description
`id`	Number	Required. The ID tied to the AniList entry.

Returns:

Returns true if added, false otherwise.

Type: Boolean

genres() → {Array.<String>}

Description:

Grabs all possible genres

Source:

index.js, line 196

Since:

1.12.0

Returns:

Type: Array.<String>

mediaTags() → {Array.<MediaTag>}

Description:

Grabs all possible media tags

Source:

index.js, line 207

Since:

1.12.0

Returns:

Type: Array.<MediaTag>

search(type, term, page, amount) → {SearchEntry}

Description:

Searches AniList based on a specific term.

Source:

index.js, line 149

Since:

1.0.0

Deprecated:

Please use AniList.Search class via `AniList.searchEntry` for updated searching. AniList.Search will replace this function in the next major update (v2.0.0).

Parameters:

Name	Type	Default	Description
`type`	String		Required. Either anime, manga, character, staff, studio, or user.
`term`	String		Required. The term to lookup. (ie: "Honzuki no Gekokujou" or "AurelicButter")
`page`	Number	`1`	Which page of the results to look at. Will default to 1 if not provided.
`amount`	Number	`5`	The amount of results per page. AniList will cap this at 25 and function will default to 5 if not provided.