@yuna0x0/anilist-node

<!doctype html> <html lang="en"> <head> <meta charset="utf-8" /> <title>Tutorial: Getting Started - 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>  <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">Tutorial: Getting Started</h1> <section> <header> <h2>Getting Started</h2> </header> <article> <h2>How to Import</h2> <p> AniList-Node is a class based, asynchronous package, meaning the main class needed to be constructed and all of its methods are async. </p> <p>For JavaScript, a simple require line and new class is perfect for the job.</p> <pre class="prettyprint source lang-JavaScript" ><code>const AniList = require("anilist-node"); const anilist = new AniList(); </code></pre> <p> However with TypeScript installs, the class is exported under the name AniList and therefore should be imported as such. AniList-Node is a CommonJS package so depending on your configurations, you may need to import it differently. </p> <pre class="prettyprint source lang-TypeScript"><code>// For projects using CommonJS modules import AniList from "anilist-node"; // For projects using ES modules import { AniList } from "anilist-node"; const anilist = new AniList(); </code></pre> <h2>Authorization</h2> <p> For a few features such as checking favourites, a token needs to be added to AniList-Node during the class initialization. </p> <p> For those without a token, head to <a href="https://anilist.co/settings/developer">Anilist's Developer Page</a> and click "Create New Client". Note the client id. Then, copy paste this URL <code >https://anilist.co/api/v2/oauth/authorize?client_id={clientID}&response_type=token</code >, replacing the <code>{clientID}</code> with your client ID. It will ask you to log in and then provide you with the token to use. You will not need to generate a token more than once. </p> <blockquote> <p> <em ><strong >NOTE: Please store your token securely and privately! This gives access to your AniList account. It is your responsibility to maintain your token.</strong ></em > </p> </blockquote> <p>Once the token is accquired, then it can be added to the class as follows.</p> <pre class="prettyprint source lang-JavaScript" ><code>const settings = require('./settings.json'); //Or wherever your store your token. const anilist = require('anilist-node'); const Anilist = new anilist(settings.token /* This being your token */); </code></pre> <h2>How to Use</h2> <p>Every class, method, and property is found within the AniList class.</p> <p> So if the program wanted to get the character information of <a href="https://anilist.co/character/126156">Myne</a> from <a href="https://anilist.co/manga/87383">Ascendance of a Bookworm</a>, it would need to get data from the character method within the <a href="AniList.People.html">people</a> class. </p> <pre class="prettyprint source lang-JavaScript" ><code>const AniList = require("anilist-node"); const anilist = new AniList(); // You can either use then... anilist.people.character(126156).then(data => { console.log(data); }); // Or await it! const data = await anilist.people.character(126156); console.log(data); </code></pre> <p> All of the methods to fetch data are the same way so please refer to the documentation on what methods are available and what data is returned in the objects. </p> </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>