Class Ships

Special ships class for extended functionality

Hierarchy

default<Ship>
- Ships

Index

Constructors

constructor

new Ships(client: AzurAPI): Ships
Constructor
Parameters
- client: AzurAPI
  
  An AzurAPI instance
Returns Ships
Overrides default.constructor
- Defined in src/core/api/api_ship.ts:18

Properties

`Protected` client

client: AzurAPI

`Optional` fuse

fuse?: Fuse<Ship>

raw

raw: Ship[]

Methods

all

all(query: string): [] | Ship[]
Get ship using everything
Parameters
- query: string
  
  basically anyting i guess
Returns [] | Ship[]
- Defined in src/core/api/api_ship.ts:127

code

code(shipCode: string): undefined | Ship
Gets a ship by their Nationality + Name. This is to differentiate, for example: HMS Enterprise and USS Enterprise.

Refer to the wiki for nation abbreviations.

Example
```
client.code('HMS Enterprise')
// –> {wikiUrl: "https://azurlane.koumakan.jp/wiki/Enterprise_(Royal_Navy)"...}
```
Parameters
- shipCode: string
  
  Generally the ship's ${nationality} ${name}
Returns undefined | Ship
- Defined in src/core/api/api_ship.ts:42

every

every(predicate: ((value: Ship, index: number, array: Ship[]) => unknown)): boolean
Determines whether all the members of an array satisfy the specified test
Parameters
- predicate: ((value: Ship, index: number, array: Ship[]) => unknown)
  
  A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  - - (value: Ship, index: number, array: Ship[]): unknown
    - Parameters
      
      value: Ship
      
      index: number
      
      array: Ship[]
      
      Returns unknown
Returns boolean
Inherited from default.every
- Defined in src/core/api/api.ts:129

filter

filter(predicate: ((value: Ship, index: number, array: Ship[]) => unknown)): Ship[]
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
- predicate: ((value: Ship, index: number, array: Ship[]) => unknown)
  
  A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
  - - (value: Ship, index: number, array: Ship[]): unknown
    - Parameters
      
      value: Ship
      
      index: number
      
      array: Ship[]
      
      Returns unknown
Returns Ship[]
Inherited from default.filter
- Defined in src/core/api/api.ts:105

forEach

forEach(callbackfn: ((value: Ship, index: number, array: Ship[]) => void)): void
Performs the specified action for each element in an array.
Parameters
- callbackfn: ((value: Ship, index: number, array: Ship[]) => void)
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Ship, index: number, array: Ship[]): void
    - Parameters
      
      value: Ship
      
      index: number
      
      array: Ship[]
      
      Returns void
Returns void
Inherited from default.forEach
- Defined in src/core/api/api.ts:121

fuze

fuze(name: string): FuseResult<Ship>[]
Search fuse cache
Parameters
- name: string
  
  Any
Returns FuseResult<Ship>[]
Inherited from default.fuze
- Defined in src/core/api/api.ts:76

get

get(query: string): Ship[]
Get ship using name in any language or id. Returns an array if an exact match isn't found.
Parameters
- query: string
  
  Ship name in any language or ship id
Returns Ship[]
Overrides default.get
- Defined in src/core/api/api_ship.ts:106

getShipIdByName

getShipIdByName(name: string, language?: string): string
Parameters
- name: string
- language: string = 'en'
Returns string
- Defined in src/core/api/api_ship.ts:137

hull

hull(hull: string): [] | Ship[]
Get ship by hull
Parameters
- hull: string
  
  Hull name
Returns [] | Ship[]
- Defined in src/core/api/api_ship.ts:76

id

id(id: string): undefined | Ship
Get by id
Parameters
- id: string
  
  String of number
Returns undefined | Ship
- Defined in src/core/api/api_ship.ts:26

map

map<U>(callbackfn: ((value: Ship, index: number, array: Ship[]) => U)): U[]
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Type Parameters
- U
Parameters
- callbackfn: ((value: Ship, index: number, array: Ship[]) => U)
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Ship, index: number, array: Ship[]): U
    - Parameters
      
      value: Ship
      
      index: number
      
      array: Ship[]
      
      Returns U
Returns U[]
Inherited from default.map
- Defined in src/core/api/api.ts:113

name

name(name: string, languages?: Language[]): [] | Ship[]
Get ship by name
Parameters
- name: string
  
  Ship name
- languages: Language[] = ...
  
  Language to search
Returns [] | Ship[]
- Defined in src/core/api/api_ship.ts:62

nationality

nationality(nationality: string): [] | Ship[]
Get ship by nationality
Parameters
- nationality: string
  
  Nationality name
Returns [] | Ship[]
- Defined in src/core/api/api_ship.ts:90

`Private` queryIsString

queryIsString(query: unknown): string
Throws is query is undefined or an object or something – anything not a string.
Parameters
- query: unknown
Returns string
- Defined in src/core/api/api_ship.ts:143

setData

setData(raw: Ship[]): void
Set the cache
Parameters
- raw: Ship[]
  
  Array
Returns void
Inherited from default.setData
- Defined in src/core/api/api.ts:65

some

some(predicate: ((value: Ship, index: number, array: Ship[]) => unknown)): boolean
Determines whether the specified callback function returns true for any element of an array.
Parameters
- predicate: ((value: Ship, index: number, array: Ship[]) => unknown)
  
  A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
  - - (value: Ship, index: number, array: Ship[]): unknown
    - Parameters
      
      value: Ship
      
      index: number
      
      array: Ship[]
      
      Returns unknown
Returns boolean
Inherited from default.some
- Defined in src/core/api/api.ts:137

Class Ships

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: AzurAPI

Returns Ships

Properties

Protected client

Optional fuse

raw

Methods

all

Parameters

query: string

Returns [] | Ship[]

code

Example

Parameters

shipCode: string

Returns undefined | Ship

every

Parameters

predicate: ((value: Ship, index: number, array: Ship[]) => unknown)

Parameters

value: Ship

index: number

array: Ship[]

Returns unknown

Returns boolean

filter

Parameters

predicate: ((value: Ship, index: number, array: Ship[]) => unknown)

Parameters

value: Ship

index: number

array: Ship[]

Returns unknown

Returns Ship[]

forEach

Parameters

callbackfn: ((value: Ship, index: number, array: Ship[]) => void)

Parameters

value: Ship

index: number

array: Ship[]

Returns void

Returns void

fuze

Parameters

name: string

Returns FuseResult<Ship>[]

get

Parameters

query: string

Returns Ship[]

getShipIdByName

Parameters

name: string

language: string = 'en'

Returns string

hull

Parameters

hull: string

Returns [] | Ship[]

id

Parameters

id: string

Returns undefined | Ship

map

Type Parameters

U

Parameters

callbackfn: ((value: Ship, index: number, array: Ship[]) => U)

Parameters

value: Ship

`Protected` client

`Optional` fuse

`Private` queryIsString