V2

Temporary v2 docs

Docs Version: 0.3.2

Next version planned features:

• flexsearch searching

• proper docs

• (more)

Known Issues:

Latest: dev-2.0.7.1
Bugs:
 - When searching with getEquipment, if the query is in English, Chinese, 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');

getBarrage

Gets barrage by query

Params: query: string, the query (barrage ID)

<client>.getBarrage('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"
  }

CLI Tool

[NEW!]

Instructions:

1. cd into the cli directory

2. run npm run build

3. ENJOYYYY

or

1. sudo npm link

or

1. install globally (npm package coming soon maybe?)

How to use:

1. cd into the cli directory

2. MacOS and Linux:

   ./acli-macos or ./acli-linux

   Windows:

   ./acli-windows.exe or double-click the exe file

   Just NodeJS:

   node acli.js

Its a test tool.