Class HeartBeat

Hierarchy (view full)

BaseClass
- HeartBeat

Index

Constructors

Properties

client down lastDowntime score status

Methods

parseDate parseStatus parseURL

Constructors

constructor

new HeartBeat(client, data): HeartBeat
Parameters
- client: Client
- data: any
Returns HeartBeat
Overrides BaseClass.constructor
- Defined in src/v4/core/heartbeat.ts:26

Properties

`Readonly`client

client: Client

`Readonly`down

down: boolean

`Readonly`lastDowntime

lastDowntime: null | Date

`Readonly`score

score: number

`Readonly`status

status: HeartBeatStatus

Methods

`Static`parseDate

parseDate<IsNullable>(input, nullable?): IsNullable extends false
? Date
: null | Date
Type Parameters
- IsNullable extends boolean = false
Parameters
- input: any
- nullable: IsNullable = ...
Returns IsNullable extends false
? Date
: null | Date
Inherited from BaseClass.parseDate
- Defined in src/v4/resource/base.ts:4

`Static`parseStatus

parseStatus(data): HeartBeatStatus
Parameters
- data: any
Returns HeartBeatStatus
- Defined in src/v4/core/heartbeat.ts:11

`Static`parseURL

parseURL<IsNullable>(input, nullable?): IsNullable extends false
? URL
: null | URL
Type Parameters
- IsNullable extends boolean = false
Parameters
- input: any
- nullable: IsNullable = ...
Returns IsNullable extends false
? URL
: null | URL
Inherited from BaseClass.parseURL
- Defined in src/v4/resource/base.ts:18