Class AzurLane

Hierarchy

AzurLane

Index

Constructors

constructor

Properties

options

Methods

Constructors

constructor

new AzurLane(options?: IOptions): AzurLane

- Defined in index.d.ts:97
Parameters
- Optional options: IOptions
  
  Constructor options
Returns AzurLane

Properties

options

options: IOptions

Methods

getBuildInfo

getBuildInfo(time: string): Promise<IConstruction>

- Defined in index.d.ts:170
since

0.0.1

Get ship names matching the given construction time

Parameters
- time: string
  
  The construction time
Returns Promise<IConstruction>

getShipById

getShipById(id: string): Promise<IShip>

- Defined in index.d.ts:121
since

1.1.0

Get information about a ship by id

Parameters
- id: string
  
  The id of the ship
Returns Promise<IShip>

getShipByName

getShipByName(name: string): Promise<IShip>

- Defined in index.d.ts:112
since

0.0.1

Get information about a ship by name

Parameters
- name: string
  
  The name of the ship
Returns Promise<IShip>

getShips

getShips(category: Category, value: string): Promise<IBaseShip[]>

- Defined in index.d.ts:131
since

1.3.0

Get a list of ships from rarity, type or affiliation

Parameters
- category: Category
  
  The category
- value: string
  
  Value depends on what category is used, e.g. if Category.RARITY is used value can be Super Rare
Returns Promise<IBaseShip[]>

getShipsWithAffiliation

getShipsWithAffiliation(affiliation: string): Promise<IBaseShip[]>

- Defined in index.d.ts:161
deprecated

Deprecated since 1.3.0 use getShips() instead, this method will be remove in 2.0.0

since

1.2.0

Get a list of ships from the affiliation

Parameters
- affiliation: string
  
  The affiliation of the ships
Returns Promise<IBaseShip[]>

getShipsWithRarity

getShipsWithRarity(rarity: string): Promise<IBaseShip[]>

- Defined in index.d.ts:141
deprecated

Deprecated since 1.3.0 use getShips() instead, this method will be remove in 2.0.0

since

1.2.0

Get a list of ships from the rarity

Parameters
- rarity: string
  
  The rarity of the ships
Returns Promise<IBaseShip[]>

getShipsWithType

getShipsWithType(type: string): Promise<IBaseShip[]>

- Defined in index.d.ts:151
deprecated

Deprecated since 1.3.0 use getShips() instead, this method will be remove in 2.0.0

since

1.2.0

Get a list of ships from the type

Parameters
- type: string
  
  The type of the ships
Returns Promise<IBaseShip[]>

Generated using TypeDoc