aniwrapper 1.0.2 | Documentation

aniwrapper

1.0.2

Anilist ▸
- Instance members
- #getUserList
- #getUserListForUser
- #searchAnime
- #updateAnime
- #addAnime
- #removeAnime
Media
entries
updateEntry

Need help reading this?

Anilist

Class Used to Interact with API

new Anilist(accessToken: String)

Parameters

accessToken (String) jwt token from Anilist API

Instance Members

▸ getUserList()

get the anime currently watching list for signed in user

getUserList(): Promise

Returns

Promise: MediaListCollection.lists [0] .entries entries

Example

const token = '<Your_TOKEN>';
const anilist = new Anilist(token);
anilist.getUserList()
.then((result) => console.log(result));

▸ getUserListForUser(variables, vars)

Retriees the list specified by the parameters

getUserListForUser(variables: any, vars: Object): Promise

Parameters

variables (any)

vars (Object) { id: Int, 'listType': 'ANIME', 'MANGA', 'status': CURRENT, PLANNING, COMPLETED, DROPPED, PAUSED, REPEATING, }

Name	Description
vars.id `Number`	Integer id of user
vars.listType `String`	Type of list - 'ANIME', 'MANGA'
vars.status `String`	CURRENT, PLANNING, COMPLETED, DROPPED, PAUSED, REPEATING,

Returns

Promise: MediaListCollection.lists [0] .entries entries

Example

const vars = {
id: 1,
listType: 'ANIME',
status: 'CURRENT'
};
const token = '<Your_TOKEN>';
const anilist = new Anilist(token);
anilist.getUserListForUser(vars)
.then((result) => console.log(result));

▸ searchAnime(name)

search for an anime

searchAnime(name: String): Promise

Parameters

name (String) name of anime

Returns

Promise: AnimeSearch.media Media

Example

const name = 'nar';
const token = '<Your_TOKEN>';
const anilist = new Anilist(token);
anilist.searchAnime(name)
.then((result) => console.log(result));

▸ updateAnime(variables, vars)

update anime for the current logged in user

updateAnime(variables: any, vars: Object): Promise

Parameters

variables (any)

vars (Object) { id: Number, mediaId: Number, status: CURRENT, PLANNING, COMPLETED, DROPPED, PAUSED, REPEATING, score: Float, progress: Number }

Name	Description
vars.id `Number`	Integer id of entry in list
vars.mediaId `Number`	Integer id of media
vars.score `Number`	float value
vars.progress `Number`	The current episode
vars.status `String`	CURRENT, PLANNING, COMPLETED, DROPPED, PAUSED, REPEATING,

Returns

Promise: SaveMediaListEntry updateEntry

Example

// if the entry for this media id is already there this will update it
const vars = { mediaId: 100240, status: 'CURRENT', progress: 1 }
const token = '<Your_TOKEN>';
const anilist = new Anilist(token);
anilist.updateAnime(vars)
.then((result) => console.log(result));

▸ addAnime(variables, vars)

add anime to current logged in user

addAnime(variables: any, vars: Object): Promise

Parameters

variables (any)

vars (Object) { id: Number, mediaId: Number, status: CURRENT, PLANNING, COMPLETED, DROPPED, PAUSED, REPEATING, score: Float, progress: Number }

Name	Description
vars.mediaId `Number`	Integer id of media
vars.score `Number`	float value
vars.progress `Number`	The current episode
vars.status `String`	CURRENT, PLANNING, COMPLETED, DROPPED, PAUSED, REPEATING,

Returns

Promise: SaveMediaListEntry updateEntry

Example

const vars = { mediaId: 100240, status: 'CURRENT', progress: 1 }
const token = '<Your_TOKEN>';
const anilist = new Anilist(token);
anilist.addAnime(vars)
.then((result) => console.log(result));

▸ removeAnime(id)

remove anime from the user list

removeAnime(id: Number): Promise

Parameters

id (Number) The id of the media list entry to delete

Returns

Promise: deleted: {Boolean}

Example

const id = 104012; //  needs to be the list id
const token = '<Your_TOKEN>';
const anilist = new Anilist(token);
anilist.removeAnime(id)
.then((result) => console.log(result));

Media

The media object

Media

Type: Object

Properties

id (Number) : id of media entry

episodes (Number) : number of episodes of the series

coverImage (Object)

coverImage.medium String
url of medium image

title (Object)

title.userPreferred String
title in user perferred
title.romaji String
title of media in romaji
title.english String
title of media in egnlish

entries

The user List media Object

entries

Type: Object

Properties

id (Number) : id of entry in list

mediaId (Number) : id of media entry

progress (Number) : the current episode number

media (...Media) : Media

updateEntry

The user List media Object created/updated

updateEntry

Type: Object

Properties

id (Number) : id of entry in list

mediaId (Number) : id of media entry

progress (Number) : the current episode number

status (String) : CURRENT, PLANNING, COMPLETED, DROPPED, PAUSED, REPEATING,