docs/index.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>MasterAnime API</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">MasterAnime API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> MasterAnime API</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="masteranime-api">MasterAnime API</h1>
<p><a href="https://travis-ci.org/OpenByteDev/MasterAnime-API"><img src="https://travis-ci.org/OpenByteDev/MasterAnime-API.svg?branch=master" alt="Build Status"></a>
<a href="https://www.npmjs.com/package/masteranime-api"><img src="https://badge.fury.io/js/masteranime-api.svg" alt="npm version"></a>
<a href="https://codeclimate.com/github/OpenByteDev/MasterAnime-API/maintainability"><img src="https://api.codeclimate.com/v1/badges/b8f4e4eedcb246e39962/maintainability" alt="Maintainability"></a>
<a href="https://codeclimate.com/github/OpenByteDev/MasterAnime-API/test_coverage"><img src="https://api.codeclimate.com/v1/badges/b8f4e4eedcb246e39962/test_coverage" alt="Test Coverage"></a>
<a href="https://david-dm.org/OpenByteDev/MasterAnime-API"><img src="https://david-dm.org/OpenByteDev/MasterAnime-API/status.svg" alt="Dependency Status"></a>
<a href="https://david-dm.org/OpenByteDev/MasterAnime-API?type=dev"><img src="https://david-dm.org/OpenByteDev/MasterAnime-API/dev-status.svg" alt="DevDependency Status"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="License"></a>
<a href=""><img src="https://img.shields.io/badge/doge-wow-yellow.svg" alt="Doge"></a></p>
<p>An api interface for <a href="https://www.masterani.me/">MasterAnime</a></p>
<hr>
<h2 id="getting-started">Getting Started</h2>
<h3 id="installation">Installation</h3>
<pre><code class="language-bash">$ npm i masteranime-api</code></pre>
<h3 id="usage">Usage</h3>
<pre><code class="language-js"><span class="hljs-keyword">const</span> { MasterAnimeAPI } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'masteranime-api'</span>);
<span class="hljs-function">(<span class="hljs-params"><span class="hljs-keyword">async</span> (</span>) =></span> {
<span class="hljs-keyword">const</span> trending = <span class="hljs-keyword">await</span> MasterAnimeAPI.getTrending();
trending.popular_today.forEach(<span class="hljs-function"><span class="hljs-params">e</span> =></span> <span class="hljs-built_in">console</span>.log(e.title));
})();</code></pre>
<h3 id="api">API</h3>
<p>The API generated with <a href="http://typedoc.org/">TypeDoc</a> can be found <a href="https://openbytedev.github.io/MasterAnime-API/">here</a>.</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="enums/order.html" class="tsd-kind-icon">Order</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/type.html" class="tsd-kind-icon">Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/filter.html" class="tsd-kind-icon">Filter</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/masteranimeapi.html" class="tsd-kind-icon">Master<wbr>AnimeAPI</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/urihelper.html" class="tsd-kind-icon">Uri<wbr>Helper</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/anime.html" class="tsd-kind-icon">Anime</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/animebasic.html" class="tsd-kind-icon">Anime<wbr>Basic</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/animedetailed.html" class="tsd-kind-icon">Anime<wbr>Detailed</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/animeinfo.html" class="tsd-kind-icon">Anime<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/animerelease.html" class="tsd-kind-icon">Anime<wbr>Release</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/episode.html" class="tsd-kind-icon">Episode</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/episodeinfo.html" class="tsd-kind-icon">Episode<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/filterlisting.html" class="tsd-kind-icon">Filter<wbr>Listing</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/filterresult.html" class="tsd-kind-icon">Filter<wbr>Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/genre.html" class="tsd-kind-icon">Genre</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/posterinfo.html" class="tsd-kind-icon">Poster<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/release.html" class="tsd-kind-icon">Release</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/synonym.html" class="tsd-kind-icon">Synonym</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/trending.html" class="tsd-kind-icon">Trending</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/trendinganime.html" class="tsd-kind-icon">Trending<wbr>Anime</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/wallpaper.html" class="tsd-kind-icon">Wallpaper</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#id" class="tsd-kind-icon">Id</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#uri" class="tsd-kind-icon">Uri</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#api_base_url" class="tsd-kind-icon">API_<wbr>BASE_<wbr>URL</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#base_url" class="tsd-kind-icon">BASE_<wbr>URL</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>