azurlane

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Azur Lane</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">Azur Lane</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> </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> Azur Lane</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <div align="center"> <br /> <p> <a href="https://discord.gg/p895czC"> <img src="https://discordapp.com/api/guilds/240059867744698368/embed.png" alt="Discord server" /> </a> <a href="https://www.npmjs.com/package/azurlane"> <img src="https://img.shields.io/npm/v/azurlane.svg?maxAge=3600" alt="NPM version" /> </a> <a href="https://www.npmjs.com/package/azurlane"> <img src="https://img.shields.io/npm/dt/azurlane.svg?maxAge=3600" alt="NPM downloads" /> </a> <a href="https://david-dm.org/KurozeroPB/azurlane"> <img src="https://img.shields.io/david/kurozeropb/azurlane.svg?maxAge=3600" alt="Dependencies" /> </a> <a href="https://www.patreon.com/Kurozero"> <img src="https://img.shields.io/badge/donate-patreon-F96854.svg" alt="Patreon" /> </a> </p> <p> <a href="https://nodei.co/npm/azurlane/"> <img src="https://nodei.co/npm/azurlane.png?downloads=true&stars=true" alt="NPM info" /> </a> </p> </div> <a href="#azurlane" id="azurlane" style="color: inherit; text-decoration: none;"> <h1>AzurLane</h1> </a> <p>Api wrapper for my azur lane api</p> <a href="#example" id="example" style="color: inherit; text-decoration: none;"> <h2>Example</h2> </a> <pre><code class="language-js"><span class="hljs-keyword">const</span> { AzurLane, Category } = <span class="hljs-built_in">require</span>(<span class="hljs-string">"azurlane"</span>); <span class="hljs-keyword">const</span> azurlane = <span class="hljs-keyword">new</span> AzurLane(); <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">main</span>(<span class="hljs-params"></span>) </span>{ <span class="hljs-comment">// Get specific ship by name, in this case "Akagi"</span> <span class="hljs-keyword">const</span> ship = <span class="hljs-keyword">await</span> azurlane.getShipByName(<span class="hljs-string">"Akagi"</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`<span class="hljs-subst">${ship.names.en}</span>'s rarity is <span class="hljs-subst">${ship.rarity}</span>`</span>); <span class="hljs-comment">// IJN Akagi's rarity is Super Rare</span> <span class="hljs-comment">// Get an array of ships with rarity "Super Rare"</span> <span class="hljs-keyword">const</span> ships = <span class="hljs-keyword">await</span> azurlane.getShips(Category.RARITY, <span class="hljs-string">"Super Rare"</span>); <span class="hljs-keyword">for</span> (<span class="hljs-keyword">let</span> i = <span class="hljs-number">0</span>; i < ships.length; i++) { <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`[<span class="hljs-subst">${ships[i].id}</span>] = <span class="hljs-subst">${ships[i].name}</span>`</span>); <span class="hljs-comment">// [036] = San Diego</span> } } <span class="hljs-comment">// Also catches any api errors that might occur like 400, 429, 500 http errors</span> <span class="hljs-comment">// Api errors extend the default error class, have a look at https://azurlane-api.github.io/AzurLane/classes/apierror.html for information</span> main().catch(<span class="hljs-built_in">console</span>.error);</code></pre> <a href="#docs" id="docs" style="color: inherit; text-decoration: none;"> <h2>Docs</h2> </a> <ul> <li>Module Docs: <a href="https://azurlane-api.github.io/AzurLane/">https://azurlane-api.github.io/AzurLane/</a></li> <li>Api Docs: <a href="https://azurlane-api.github.io/azurlane-api/">https://azurlane-api.github.io/azurlane-api/</a></li> </ul> <p>I recommend looking at the api docs to see what data is returned before spamming the api with useless requests only to see what it actually returns.</p> <a href="#support" id="support" style="color: inherit; text-decoration: none;"> <h2>Support</h2> </a> <p><img src="https://discordapp.com/api/v6/guilds/240059867744698368/widget.png?style=banner2" alt="discord"></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/category.html" class="tsd-kind-icon">Category</a> </li> <li class=" tsd-kind-class"> <a href="classes/apierror.html" class="tsd-kind-icon">Api<wbr>Error</a> </li> <li class=" tsd-kind-class"> <a href="classes/azurlane.html" class="tsd-kind-icon">Azur<wbr>Lane</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/ibaseresponse.html" class="tsd-kind-icon">IBase<wbr>Response</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/ibaseship.html" class="tsd-kind-icon">IBase<wbr>Ship</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/ibuildresponse.html" class="tsd-kind-icon">IBuild<wbr>Response</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/iconstruction.html" class="tsd-kind-icon">IConstruction</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/ierrorresponse.html" class="tsd-kind-icon">IError<wbr>Response</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/imiscellaneous.html" class="tsd-kind-icon">IMiscellaneous</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/imiscellaneousinfo.html" class="tsd-kind-icon">IMiscellaneous<wbr>Info</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/inames.html" class="tsd-kind-icon">INames</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/ioptions.html" class="tsd-kind-icon">IOptions</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/iship.html" class="tsd-kind-icon">IShip</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/ishipresponse.html" class="tsd-kind-icon">IShip<wbr>Response</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/iskin.html" class="tsd-kind-icon">ISkin</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/istars.html" class="tsd-kind-icon">IStars</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/istats.html" class="tsd-kind-icon">IStats</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/istatsitem.html" class="tsd-kind-icon">IStats<wbr>Item</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> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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="https://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>