Class AzurAPI

The main AzurAPI class

Hierarchy

EventEmitter
- AzurAPI

Constructors

constructor

new AzurAPI(options?: CacheOptions): AzurAPI
Cache client
Parameters
- Optional options: CacheOptions
  
  options for the cache
Returns AzurAPI
Overrides EventEmitter.constructor
- Defined in src/core/Client.ts:46

Properties

apis

apis: {
    barrages: Barrages;
    chapters: Chapters;
    equipments: Equipments;
    ships: Ships;
    voicelines: Voicelines;
} = ...

Type declaration

barrages: Barrages
chapters: Chapters
equipments: Equipments
ships: Ships
voicelines: Voicelines

autoupdate

autoupdate: boolean

barrages

barrages: Barrages = ...

chapters

chapters: Chapters = ...

equipments

equipments: Equipments = ...

options

options: CacheOptions

rate

rate: number

ships

ships: Ships = ...

source

source: string

updater

updater: default

voicelines

voicelines: Voicelines = ...

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): AzurAPI
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns AzurAPI
Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:57

emit

emit(event: string | symbol, ...args: any[]): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:67

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:72

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:64

getShipIdByName

getShipIdByName(name: string): string
Another bodge...
Parameters
- name: string
Returns string
- Defined in src/core/Client.ts:94

listenerCount

listenerCount(event: string | symbol): number
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:68

listeners

listeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:65

off

off(event: string | symbol, listener: ((...args: any[]) => void)): AzurAPI
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns AzurAPI
Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:61

on

on(event: string | symbol, listener: ((...args: any[]) => void)): AzurAPI
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns AzurAPI
Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:58

once

once(event: string | symbol, listener: ((...args: any[]) => void)): AzurAPI
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns AzurAPI
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:59

prependListener

prependListener(event: string | symbol, listener: ((...args: any[]) => void)): AzurAPI
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns AzurAPI
Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:70

prependOnceListener

prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): AzurAPI
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns AzurAPI
Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:71

queryIsShipName

queryIsShipName(query: string): boolean
Bodge until we can rewrite query string matches a ship's name.
Parameters
- query: string
Returns boolean
- Defined in src/core/Client.ts:88

rawListeners

rawListeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:66

removeAllListeners

removeAllListeners(event?: string | symbol): AzurAPI
Parameters
- Optional event: string | symbol
Returns AzurAPI
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:62

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): AzurAPI
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns AzurAPI
Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:60

set

set(type: datatype, raw: any[]): undefined | Ships | Equipments | Chapters | Voicelines | Barrages
Set data in cache
Parameters
- type: datatype
  
  A type of data (ship, equipment, voiceline, chapter, or barrage)
- raw: any[]
  
  Raw data in array
Returns undefined | Ships | Equipments | Chapters | Voicelines | Barrages
- Defined in src/core/Client.ts:78

setMaxListeners

setMaxListeners(n: number): AzurAPI
Parameters
- n: number
Returns AzurAPI
Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:63

`Static` listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number
Deprecated
since v4.0.0
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:21
once(emitter: DOMEventTarget, event: string): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22

Class AzurAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: CacheOptions

Returns AzurAPI

Properties

apis

Type declaration

barrages: Barrages

chapters: Chapters

equipments: Equipments

ships: Ships

voicelines: Voicelines

autoupdate

barrages

chapters

equipments

options

rate

ships

source

updater

voicelines

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns AzurAPI

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

getShipIdByName

Parameters

name: string

Returns string

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns AzurAPI

on

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns AzurAPI

once

`Optional` options: CacheOptions

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` event: string | symbol

`Rest` ...args: any[]

`Static` listenerCount

`Static` on

`Static` once