@azurapi/azurapi
Version:
Open Source Azur Lane Local Database
63 lines (49 loc) • 2.62 kB
Markdown
<img src="https://github.com/AzurAPI/Media/blob/master/AzurAPI-JS/RepoBanner/RepoBanner.png" />
<div align="center">
<br />
<p>
<a href="https://discord.gg/aAEdys8">
<img src="https://discordapp.com/api/guilds/648206344729526272/embed.png" alt="Discord server" />
</a>
<a href="https://www.npmjs.com/package/@azurapi/azurapi">
<img src="https://img.shields.io/npm/dt/@azurapi/azurapi.svg?maxAge=3600" alt="NPM downloads" />
</a>
<a href="https://www.npmjs.com/package/@azurapi/azurapi">
<img src="https://img.shields.io/npm/v/@azurapi/azurapi.svg?maxAge=3600" alt="NPM version" />
</a>
<a href="https://starbuck.gabrielcsapo.com/github/azurapi/azurapi-js/">
<img src="https://starbuck.gabrielcsapo.com/badge/github/azurapi/azurapi-js/status.svg?maxAge=3600" alt="Dependencies" />
</a>
</p>
<p>
<a href="https://github.com/AzurAPI/azurapi-js/actions">
<img src="https://github.com/AzurAPI/azurapi-js/workflows/Github%20Actions/badge.svg?branch=master" alt="Github Actions" />
</a>
<a href="https://ci.nekos.cloud/buildConfiguration/AzurapiJs_Build?guest=1"><img src="https://ci.nekos.cloud/app/rest/builds/buildType:id:AzurapiJs_Build/statusIcon.svg"></a>
</p>
<p><a href="https://npmjs.com/package/@azurapi/azurapi"><img src="https://nodei.co/npm/@azurapi/azurapi.png?downloads=true&downloadRank=true&stars=true"></a>
</p>
</div>
# AzurApi-~~JS~~TS
Open Source Library For Azur Lane
## Features
- Hosted Locally in your machine, no more waiting for server downtime!!!
- Ship Information and Specific Data Searching
- More to come soon
## Requirement
This package needs Node version `14.0.0` or newer.
## Install
Get stable package from npm by running `npm install --save @azurapi/azurapi` in the command line.
Alternatively, use the web builds:
Minified: https://git.io/azurapi.min.js
UMD Module: https://git.io/azurapi.umd.js
## Usage / Documentation
To use the Library, Please refer to the [Docs](https://azurapi.github.io/v2/).
For advanced users or package developers, please refer to [TSDoc](https://azurapi.github.io/azurapi-js/).
## Breaking Changes
### 1.1.0
- All functions from accessors after verion 1.1.0 return arrays.
- Bundles are now built with typescript version 4.5.5
## Discord Support Server
[](https://discord.gg/aAEdys8)
Discord Link: https://discord.gg/aAEdys8