@yuna0x0/anilist-node
Version:
A lightweight Node.js wrapper for the AniList API
1,972 lines (1,520 loc) • 326 kB
HTML
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Global - AniList-Node Documentation</title>
<meta name="description" content="Documentation for the AniList-Node NPM package." />
<meta property="og:title" content="AniList-Node Documentation" />
<meta property="og:type" content="website" />
<meta property="og:image" content="" />
<meta property="og:site_name" content="AniList-Node Documentation" />
<meta property="og:url" content="https://katsurin.com/docs/anilist-node/" />
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css" />
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css" />
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<input type="text" id="nav-search" placeholder="Search" />
<h2><a href="index.html">Home</a></h2>
<h2>
<a
href="https://github.com/AurelicButter/AniList-Node"
target="_blank"
class="menu-item"
id="website_link"
>GitHub Repository</a
>
</h2>
<h2>
<a href="https://www.npmjs.com/package/anilist-node" target="_blank" class="menu-item" id="website_link"
>AniList-Node on NPM</a
>
</h2>
<h2>
<a href="https://discord.gg/qKfqsjW" target="_blank" class="menu-item" id="website_link"
>Support Server</a
>
</h2>
<h3>Classes</h3>
<ul>
<li>
<a href="AniList.html">AniList</a>
<ul class="methods">
<li data-type="method"><a href="AniList.html#favouriteStudio">favouriteStudio</a></li>
<li data-type="method"><a href="AniList.html#genres">genres</a></li>
<li data-type="method"><a href="AniList.html#mediaTags">mediaTags</a></li>
<li data-type="method"><a href="AniList.html#search">search</a></li>
<li data-type="method"><a href="AniList.html#siteStatistics">siteStatistics</a></li>
<li data-type="method"><a href="AniList.html#studio">studio</a></li>
</ul>
</li>
<li>
<a href="AniList.Activity.html">Activity</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Activity.html#delete">delete</a></li>
<li data-type="method"><a href="AniList.Activity.html#get">get</a></li>
<li data-type="method"><a href="AniList.Activity.html#getUserActivity">getUserActivity</a></li>
<li data-type="method"><a href="AniList.Activity.html#postMessage">postMessage</a></li>
<li data-type="method"><a href="AniList.Activity.html#postText">postText</a></li>
</ul>
</li>
<li>
<a href="AniList.Lists.html">Lists</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Lists.html#addEntry">addEntry</a></li>
<li data-type="method"><a href="AniList.Lists.html#anime">anime</a></li>
<li data-type="method"><a href="AniList.Lists.html#manga">manga</a></li>
<li data-type="method"><a href="AniList.Lists.html#removeEntry">removeEntry</a></li>
<li data-type="method"><a href="AniList.Lists.html#updateEntry">updateEntry</a></li>
</ul>
</li>
<li>
<a href="AniList.Media.html">Media</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Media.html#anime">anime</a></li>
<li data-type="method"><a href="AniList.Media.html#favouriteAnime">favouriteAnime</a></li>
<li data-type="method"><a href="AniList.Media.html#favouriteManga">favouriteManga</a></li>
<li data-type="method"><a href="AniList.Media.html#manga">manga</a></li>
</ul>
</li>
<li>
<a href="AniList.People.html">People</a>
<ul class="methods">
<li data-type="method"><a href="AniList.People.html#character">character</a></li>
<li data-type="method"><a href="AniList.People.html#favouriteChar">favouriteChar</a></li>
<li data-type="method"><a href="AniList.People.html#favouriteStaff">favouriteStaff</a></li>
<li data-type="method">
<a href="AniList.People.html#getBirthdayCharacters">getBirthdayCharacters</a>
</li>
<li data-type="method"><a href="AniList.People.html#getBirthdayStaff">getBirthdayStaff</a></li>
<li data-type="method"><a href="AniList.People.html#staff">staff</a></li>
</ul>
</li>
<li>
<a href="AniList.Recommendation.html">Recommendation</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Recommendation.html#get">get</a></li>
<li data-type="method"><a href="AniList.Recommendation.html#getList">getList</a></li>
</ul>
</li>
<li>
<a href="AniList.Search.html">Search</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Search.html#activity">activity</a></li>
<li data-type="method"><a href="AniList.Search.html#anime">anime</a></li>
<li data-type="method"><a href="AniList.Search.html#character">character</a></li>
<li data-type="method"><a href="AniList.Search.html#manga">manga</a></li>
<li data-type="method"><a href="AniList.Search.html#staff">staff</a></li>
<li data-type="method"><a href="AniList.Search.html#studio">studio</a></li>
<li data-type="method"><a href="AniList.Search.html#user">user</a></li>
</ul>
</li>
<li>
<a href="AniList.Thread.html">Thread</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Thread.html#delete">delete</a></li>
<li data-type="method"><a href="AniList.Thread.html#get">get</a></li>
<li data-type="method"><a href="AniList.Thread.html#getComments">getComments</a></li>
</ul>
</li>
<li>
<a href="AniList.User.html">User</a>
<ul class="methods">
<li data-type="method"><a href="AniList.User.html#all">all</a></li>
<li data-type="method"><a href="AniList.User.html#follow">follow</a></li>
<li data-type="method"><a href="AniList.User.html#getAuthorized">getAuthorized</a></li>
<li data-type="method"><a href="AniList.User.html#getRecentActivity">getRecentActivity</a></li>
<li data-type="method"><a href="AniList.User.html#profile">profile</a></li>
<li data-type="method"><a href="AniList.User.html#stats">stats</a></li>
<li data-type="method"><a href="AniList.User.html#update">update</a></li>
</ul>
</li>
</ul>
<h3>Tutorials</h3>
<ul>
<li><a href="tutorial-Filtering.html">Filtering</a></li>
<li><a href="tutorial-Getting Started.html">Getting Started</a></li>
</ul>
<h3>Global</h3>
<ul>
<li><a href="global.html#ActivityEntry">ActivityEntry</a></li>
<li><a href="global.html#ActivityFilterTypes">ActivityFilterTypes</a></li>
<li><a href="global.html#ActivitySort">ActivitySort</a></li>
<li><a href="global.html#ActivityType">ActivityType</a></li>
<li><a href="global.html#AiringEntry">AiringEntry</a></li>
<li><a href="global.html#AniListStats">AniListStats</a></li>
<li><a href="global.html#AnimeEntry">AnimeEntry</a></li>
<li><a href="global.html#CharacterEntry">CharacterEntry</a></li>
<li><a href="global.html#CharacterName">CharacterName</a></li>
<li><a href="global.html#CountryCode">CountryCode</a></li>
<li><a href="global.html#EntryStatus">EntryStatus</a></li>
<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
<li><a href="global.html#InitOptions">InitOptions</a></li>
<li><a href="global.html#ListActivity">ListActivity</a></li>
<li><a href="global.html#ListEntry">ListEntry</a></li>
<li><a href="global.html#MangaEntry">MangaEntry</a></li>
<li><a href="global.html#MediaFilterTypes">MediaFilterTypes</a></li>
<li><a href="global.html#MediaFormat">MediaFormat</a></li>
<li><a href="global.html#MediaListOptions">MediaListOptions</a></li>
<li><a href="global.html#MediaListOptionsInput">MediaListOptionsInput</a></li>
<li><a href="global.html#MediaRelation">MediaRelation</a></li>
<li><a href="global.html#MediaSeason">MediaSeason</a></li>
<li><a href="global.html#MediaSort">MediaSort</a></li>
<li><a href="global.html#MediaSource">MediaSource</a></li>
<li><a href="global.html#MediaStatus">MediaStatus</a></li>
<li><a href="global.html#MediaTag">MediaTag</a></li>
<li><a href="global.html#MediaTitle">MediaTitle</a></li>
<li><a href="global.html#MediaType">MediaType</a></li>
<li><a href="global.html#MessageActivity">MessageActivity</a></li>
<li><a href="global.html#ModRole">ModRole</a></li>
<li><a href="global.html#NotificationOption">NotificationOption</a></li>
<li><a href="global.html#NotificationType">NotificationType</a></li>
<li><a href="global.html#PersonName">PersonName</a></li>
<li><a href="global.html#PersonRelation">PersonRelation</a></li>
<li><a href="global.html#RecommendationEntry">RecommendationEntry</a></li>
<li><a href="global.html#RecommendationList">RecommendationList</a></li>
<li><a href="global.html#RecommendationRating">RecommendationRating</a></li>
<li><a href="global.html#ScoreFormat">ScoreFormat</a></li>
<li><a href="global.html#SearchEntry">SearchEntry</a></li>
<li><a href="global.html#SingleRecommendation">SingleRecommendation</a></li>
<li><a href="global.html#StaffEntry">StaffEntry</a></li>
<li><a href="global.html#StaffName">StaffName</a></li>
<li><a href="global.html#StudioEntry">StudioEntry</a></li>
<li><a href="global.html#TextActivity">TextActivity</a></li>
<li><a href="global.html#ThreadComment">ThreadComment</a></li>
<li><a href="global.html#ThreadEntry">ThreadEntry</a></li>
<li><a href="global.html#UpdateEntryOptions">UpdateEntryOptions</a></li>
<li><a href="global.html#UpdatedEntry">UpdatedEntry</a></li>
<li><a href="global.html#UserList">UserList</a></li>
<li><a href="global.html#UserOptions">UserOptions</a></li>
<li><a href="global.html#UserOptionsInput">UserOptionsInput</a></li>
<li><a href="global.html#UserProfile">UserProfile</a></li>
<li><a href="global.html#UserRelation">UserRelation</a></li>
<li><a href="global.html#UserStaffNameLanguage">UserStaffNameLanguage</a></li>
<li><a href="global.html#UserStats">UserStats</a></li>
<li><a href="global.html#UserTitleLanguage">UserTitleLanguage</a></li>
<li><a href="global.html#headerBuilder">headerBuilder</a></li>
</ul>
</nav>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details"></dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="ActivitySort">
<span class="type-signature type-signature-constant">(constant) </span>ActivitySort<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for activity sorting</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_activitySort.js.html">types/activitySort.js</a>,
<a href="types_activitySort.js.html#line7">line 7</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ID</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>ID_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for activity sorting</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="ActivityType">
<span class="type-signature type-signature-constant">(constant) </span>ActivityType<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for activity types</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_activityType.js.html">types/activityType.js</a>,
<a href="types_activityType.js.html#line7">line 7</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>TEXT</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>ANIME_LIST</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MANGA_LIST</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MESSAGE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MEDIA_LIST</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for activity types</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="EntryStatus">
<span class="type-signature type-signature-constant">(constant) </span>EntryStatus<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for list entry status</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_entryStatus.js.html">types/entryStatus.js</a>,
<a href="types_entryStatus.js.html#line6">line 6</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>CURRENT</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>PLANNING</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>COMPLETED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DROPPED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>PAUSED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>REPEATING</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for list entry status</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="MediaFormat">
<span class="type-signature type-signature-constant">(constant) </span>MediaFormat<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for media formats</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_mediaFormat.js.html">types/mediaFormat.js</a>,
<a href="types_mediaFormat.js.html#line6">line 6</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>TV</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TV_SHORT</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MOVIE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SPECIAL</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>OVA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>ONA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MUSIC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MANGA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>NOVEL</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>ONE_SHOT</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for media formats</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="MediaSeason">
<span class="type-signature type-signature-constant">(constant) </span>MediaSeason<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for media seasons</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_mediaSeason.js.html">types/mediaSeason.js</a>,
<a href="types_mediaSeason.js.html#line7">line 7</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>WINTER</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SPRING</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SUMMER</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>FALL</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for media seasons</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="MediaSort">
<span class="type-signature type-signature-constant">(constant) </span>MediaSort<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for media sorting</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_mediaSort.js.html">types/mediaSort.js</a>,
<a href="types_mediaSort.js.html#line6">line 6</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ID</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>ID_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TITLE_ROMAJI</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TITLE_ROMAJI_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TITLE_ENGLISH</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TITLE_ENGLISH_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TITLE_NATIVE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TITLE_NATIVE_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TYPE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TYPE_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>FORMAT</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>FORMAT_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>START_DATE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>START_DATE_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>END_DATE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>END_DATE_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SCORE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SCORE_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>POPULARITY</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>POPULARITY_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TRENDING</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TRENDING_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>EPISODES</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>EPISODES_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DURATION</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DURATION_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>STATUS</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>STATUS_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>CHAPTERS</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>CHAPTERS_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VOLUMES</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VOLUMES_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>UPDATED_AT</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>UPDATED_AT_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SEARCH_MATCH</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>FAVOURITES</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>FAVOURITES_DESC</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for media sorting</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="MediaSource">
<span class="type-signature type-signature-constant">(constant) </span>MediaSource<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for media sources</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_mediaSource.js.html">types/mediaSource.js</a>,
<a href="types_mediaSource.js.html#line7">line 7</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ORIGINAL</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MANGA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>LIGHT_NOVEL</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VISUAL_NOVEL</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VIDEO_GAME</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>OTHER</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>NOVEL</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DOUJINSHI</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>ANIME</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for media sources</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="MediaStatus">
<span class="type-signature type-signature-constant">(constant) </span>MediaStatus<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for media statuses</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_mediaStatus.js.html">types/mediaStatus.js</a>,
<a href="types_mediaStatus.js.html#line6">line 6</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>FINISHED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>RELEASING</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>NOT_YET_RELEASED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>CANCELLED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>HIATUS</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for media statuses</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="MediaType">
<span class="type-signature type-signature-constant">(constant) </span>MediaType<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for media types</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_mediaType.js.html">types/mediaType.js</a>,
<a href="types_mediaType.js.html#line7">line 7</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ANIME</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MANGA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for media types</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="ModRole">
<span class="type-signature type-signature-constant">(constant) </span>ModRole<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for moderator roles on users</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_modRoles.js.html">types/modRoles.js</a>,
<a href="types_modRoles.js.html#line7">line 7</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ADMIN</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">An AniList administrator</td>
</tr>
<tr>
<td class="name"><code>LEAD_DEVELOPER</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A head developer of AniList</td>
</tr>
<tr>
<td class="name"><code>DEVELOPER</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">An AniList developer</td>
</tr>
<tr>
<td class="name"><code>LEAD_COMMUNITY</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A lead community moderator</td>
</tr>
<tr>
<td class="name"><code>COMMUNITY</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A community moderator</td>
</tr>
<tr>
<td class="name"><code>DISCORD_COMMUNITY</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A discord community moderator</td>
</tr>
<tr>
<td class="name"><code>LEAD_ANIME_DATA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A lead anime data moderator</td>
</tr>
<tr>
<td class="name"><code>ANIME_DATA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">An anime data moderator</td>
</tr>
<tr>
<td class="name"><code>LEAD_MANGA_DATA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A lead manga data moderator</td>
</tr>
<tr>
<td class="name"><code>MANGA_DATA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A manga data moderator</td>
</tr>
<tr>
<td class="name"><code>LEAD_SOCIAL_MEDIA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A lead social media moderator</td>
</tr>
<tr>
<td class="name"><code>SOCIAL_MEDIA</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A social media moderator</td>
</tr>
<tr>
<td class="name"><code>RETIRED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A retired moderator</td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for moderator roles on users</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="NotificationType">
<span class="type-signature type-signature-constant">(constant) </span>NotificationType<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for notification types</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_notificationType.js.html">types/notificationType.js</a>,
<a href="types_notificationType.js.html#line7">line 7</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ACTIVITY_MESSAGE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Recieved a message</td>
</tr>
<tr>
<td class="name"><code>ACTIVITY_REPLY</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Replied to user's activity</td>
</tr>
<tr>
<td class="name"><code>FOLLOWING</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Another user has followed</td>
</tr>
<tr>
<td class="name"><code>ACTIVITY_MENTION</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A user has mentioned you in their activity</td>
</tr>
<tr>
<td class="name"><code>THREAD_COMMENT_MENTION</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A user has mentioned you in a forum comment</td>
</tr>
<tr>
<td class="name"><code>THREAD_SUBSCRIBED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
A user has commented in one of your subscribed forum threads
</td>
</tr>
<tr>
<td class="name"><code>THREAD_COMMENT_REPLY</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A user has replied to your forum comment</td>
</tr>
<tr>
<td class="name"><code>AIRING</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">An anime you are currently watching has aired</td>
</tr>
<tr>
<td class="name"><code>ACTIVITY_LIKE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A user has liked your activity</td>
</tr>
<tr>
<td class="name"><code>ACTIVITY_REPLY_LIKE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A user has liked your activity reply</td>
</tr>
<tr>
<td class="name"><code>THREAD_LIKE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A user has liked your forum thread</td>
</tr>
<tr>
<td class="name"><code>THREAD_COMMENT_LIKE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A user has liked your forum comment</td>
</tr>
<tr>
<td class="name"><code>ACTIVITY_REPLY_SUBSCRIBED</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
A user has replied to activity you have also replied to
</td>
</tr>
<tr>
<td class="name"><code>RELATED_MEDIA_ADDITION</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
A new anime or manga has been added to the site where its related media is on the
user's list
</td>
</tr>
<tr>
<td class="name"><code>MEDIA_DATA_CHANGE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
An anime or manga has had a data change that affects how a user may track it in
their lists
</td>
</tr>
<tr>
<td class="name"><code>MEDIA_MERGE</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
Anime or manga entries on the user's list have been merged into a single entry
</td>
</tr>
<tr>
<td class="name"><code>MEDIA_DELETION</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
An anime or manga on the user's list has been deleted from the site
</td>
</tr>
</tbody>
</table>
<div class="description usertext">An enum for notification types</div>
<h5 class="h5-types">Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<h4 class="name" id="RecommendationRating">
<span class="type-signature type-signature-constant">(constant) </span>RecommendationRating<span
class="type-signature"
>
:String</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>An enum for recommendation ratings</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="types_recommendationRating.js.html">types/recommendationRating.js</a>,
<a href="types_recommendationRating.js.html#line7">line 7</a>
</li>
</ul>
</dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>NO_RATING</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>