@yuna0x0/anilist-node
Version:
A lightweight Node.js wrapper for the AniList API
690 lines (587 loc) • 21.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8" />
<title>People - 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">People</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="AniList.html">AniList</a>.</span>
People
</h2>
<div class="class-description usertext">Access AniList's characters and staff data.</div>
</header>
<article>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="character">
<span class="type-signature"></span>character<span class="signature">(id)</span
><span class="type-signature">
→ {<a href="global.html#CharacterEntry">CharacterEntry</a>}</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>Fetch a character entry by its AniList ID.</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="people.js.html">people.js</a>, <a href="people.js.html#line23">line 23</a>
</li>
</ul>
</dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since">
<ul class="dummy">
<li>1.0.0</li>
</ul>
</dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<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">Number</span>
|
<span class="param-type">String</span>
</td>
<td class="description last">Required. The ID tied to the AniList entry.</td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<dl class="param-type">
<dt>Type</dt>
<dd>
<span class="param-type"><a href="global.html#CharacterEntry">CharacterEntry</a></span>
</dd>
</dl>
<h4 class="name" id="favouriteChar">
<span class="type-signature type-signature-async">(async) </span>favouriteChar<span
class="signature"
>(id)</span
><span class="type-signature"> → {Boolean}</span>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>[Requires Login] Favourite/Unfavourite a character</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="people.js.html">people.js</a>, <a href="people.js.html#line42">line 42</a>
</li>
</ul>
</dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since">
<ul class="dummy">
<li>1.12.0</li>
</ul>
</dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<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">Number</span>
</td>
<td class="description last">Required. The ID tied to the AniList entry.</td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<div class="param-desc">Returns true if added, false otherwise.</div>
<dl class="param-type">
<dt>Type</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="favouriteStaff">
<span class="type-signature type-signature-async">(async) </span>favouriteStaff<span
class="signature"
>(id)</span
><span class="type-signature"> → {Boolean}</span>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>[Requires Login] Favourite/Unfavourite a staff entry</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="people.js.html">people.js</a>,
<a href="people.js.html#line112">line 112</a>
</li>
</ul>
</dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since">
<ul class="dummy">
<li>1.12.0</li>
</ul>
</dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<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">Number</span>
</td>
<td class="description last">Required. The ID tied to the AniList entry.</td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<div class="param-desc">Returns true if added, false otherwise.</div>
<dl class="param-type">
<dt>Type</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="getBirthdayCharacters">
<span class="type-signature type-signature-async">(async) </span>getBirthdayCharacters<span
class="signature"
>(page)</span
><span class="type-signature">
→ {Array.<<a href="global.html#PersonRelation">PersonRelation</a>>}</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>Get all characters who's birthday is today</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="people.js.html">people.js</a>, <a href="people.js.html#line69">line 69</a>
</li>
</ul>
</dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since">
<ul class="dummy">
<li>1.14.0</li>
</ul>
</dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>page</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code>1</code>
</td>
<td class="description last">What page in the search to target. Defaults at 1.</td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<dl class="param-type">
<dt>Type</dt>
<dd>
<span class="param-type"
>Array.<<a href="global.html#PersonRelation">PersonRelation</a>></span
>
</dd>
</dl>
<h4 class="name" id="getBirthdayStaff">
<span class="type-signature type-signature-async">(async) </span>getBirthdayStaff<span
class="signature"
>(page)</span
><span class="type-signature">
→ {Array.<<a href="global.html#PersonRelation">PersonRelation</a>>}</span
>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>Get all staff entries who's birthday is today</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="people.js.html">people.js</a>,
<a href="people.js.html#line139">line 139</a>
</li>
</ul>
</dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since">
<ul class="dummy">
<li>1.14.0</li>
</ul>
</dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>page</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code>1</code>
</td>
<td class="description last">What page in the search to target. Defaults at 1.</td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<dl class="param-type">
<dt>Type</dt>
<dd>
<span class="param-type"
>Array.<<a href="global.html#PersonRelation">PersonRelation</a>></span
>
</dd>
</dl>
<h4 class="name" id="staff">
<span class="type-signature"></span>staff<span class="signature">(id)</span
><span class="type-signature"> → {<a href="global.html#StaffEntry">StaffEntry</a>}</span>
</h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>Fetch a staff entry by its AniList ID or their name.</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="people.js.html">people.js</a>, <a href="people.js.html#line91">line 91</a>
</li>
</ul>
</dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since">
<ul class="dummy">
<li>1.0.0</li>
</ul>
</dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<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">Number</span>
|
<span class="param-type">String</span>
</td>
<td class="description last">
Required. The ID can either be the AniList ID or the staff's name.
</td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<dl class="param-type">
<dt>Type</dt>
<dd>
<span class="param-type"><a href="global.html#StaffEntry">StaffEntry</a></span>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear" />
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> using the
<a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>
prettyPrint();
</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/search.js" defer></script>
</body>
</html>