V2

Temporary v2 docs

Known Issues:

Latest: dev-2.0.6.4
Bugs:
 - When searching with section, getChapter shifts one forward or returns undefined if matched.
 - When searching with getEquipment, if the query is in Japanese or Korean, it returns an empty array/nothing if matched.

Import package:

import { AzurAPIClient } from @azurapi/azurapi

Methods:

getShips:

Returns a list of ships from GitHub hosted data.

<client>.getShips();

getEquipments():

Returns a list of equipments from GitHub hosted data.

<client>.getEquipments();

getChapters:

Returns a list of chapters from GitHub hosted data.

<client>.getChapters();

getVoicelines:

Returns a list of voice lines from GitHub hosted data.

<client>.getVoicelines();

getBarrages:

Returns a list of barragess from GitHub hosted data.

<client>.getBarrages();

getShip:

Gets ship by query.

Params:

query: string, the query (id or name)

<client>.getShip('query');

getShipsByFaction:

Get ship by faction.

Params:

faction: string, the faction to find ships from (Type: Nationality)

<client>.getShipByFaction('faction');

getEquipment:

Gets equipment by query

Params:

query: string, the query (equipment name)

<client>.getEquipment('query');

getChapter:

Gets chapter by chapter number or chapter number & section

Params:

query: string, the query (chapter number)

section: (optional) string, the query (section number/name)

<client>.getChapter('query', 'section');

getVoiceline

Gets voice line by query

Params:

query: string, the query (ship id or ship name)

<client>.getVoiceline('query');

Extras:

NPM Scripts:

npm run compile

npm run test

npm run lint

Node Modules:

  "dependencies": {
    "@augu/orchid": "1.6.5",
  },
  "devDependencies": {
    "@augu/eslint-config": "1.8.2",
    "@types/jest": "26.0.14",
    "@types/node": "14.11.2",
    "@typescript-eslint/eslint-plugin": "4.2.0",
    "@typescript-eslint/parser": "4.2.0",
    "eslint": "^7.9.0",
    "jest": "26.4.2",
    "ts-jest": "26.4.0",
    "typescript": "4.0.3"
  }