azurlane
Version:
Api wrapper for the azur lane api
60 lines (51 loc) • 2.37 kB
Markdown
<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>
Api wrapper for my azur lane api
```js
const { AzurLane, Category } = require("azurlane");
const azurlane = new AzurLane();
async function main() {
// Get specific ship by name, in this case "Akagi"
const ship = await azurlane.getShipByName("Akagi");
console.log(`${ship.names.en}'s rarity is ${ship.rarity}`); // IJN Akagi's rarity is Super Rare
// Get an array of ships with rarity "Super Rare"
const ships = await azurlane.getShips(Category.RARITY, "Super Rare");
for (let i = 0; i < ships.length; i++) {
console.log(`[${ships[i].id}] = ${ships[i].name}`); // [036] = San Diego
}
}
// Also catches any api errors that might occur like 400, 429, 500 http errors
// Api errors extend the default error class, have a look at https://azurlane-api.github.io/AzurLane/classes/apierror.html for information
main().catch(console.error);
```
- Module Docs: https://azurlane-api.github.io/AzurLane/
- Api Docs: https://azurlane-api.github.io/azurlane-api/
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.
