@types/Node
Table of contents
Interfaces
- PlayerEventPayload
- TrackEndEvent
- TrackExceptionEvent
- TrackStartEvent
- TrackStuckEvent
- WebSocketClosedEvent
Type Aliases
Type Aliases
Info
Ƭ Info: Object
Lavalink Info
Type declaration
| Name | Type |
|---|---|
buildTime | number |
filters | string[] |
git | { branch: string ; commit: string ; commitTime: number } |
git.branch | string |
git.commit | string |
git.commitTime | number |
jvm | string |
lavaplayer | string |
plugins | { name: string ; version: string }[] |
sourceManagers | string[] |
version | { major: number ; minor: number ; patch: number ; preRelease: string | null ; semver: string } |
version.major | number |
version.minor | number |
version.patch | number |
version.preRelease | string | null |
version.semver | string |
Defined in
NodeOptions
Ƭ NodeOptions: Object
Lavalink node options
Type declaration
| Name | Type | Description |
|---|---|---|
followRedirects? | boolean | Whether to follow redirects or not (default is false) |
hostname | string | The node hostname |
id? | string | The node identifier |
maxRetryAttempts? | number | The max number of retry attempts |
password? | string | The node password |
port | number | The node port |
resumeKey? | "enable" | "disable" | "ENABLE" | "DISABLE" | Whether to enable resume key |
resumeTimeout? | number | The resume timeout, in seconds |
retryAttemptsInterval? | number | The interval between retry attempts |
secure? | boolean | Whether to use SSL/TLS or not |
Defined in
NodeStats
Ƭ NodeStats: Object
Lavalink node stats
Type declaration
| Name | Type | Description |
|---|---|---|
cpu | { cores: number ; lavalinkLoad: number ; systemLoad: number } | CPU stats, [0, 1] |
cpu.cores | number | - |
cpu.lavalinkLoad | number | - |
cpu.systemLoad | number | - |
frameStats? | { deficit: number ; nulled: number ; sent: number } | Audio frame stats |
frameStats.deficit | number | - |
frameStats.nulled | number | - |
frameStats.sent | number | - |
memory | { allocated: number ; free: number ; reservable: number ; used: number } | RAM stats, in bytes |
memory.allocated | number | - |
memory.free | number | - |
memory.reservable | number | - |
memory.used | number | - |
players | number | The total player amount |
playingPlayers | number | The amount of playing players |
uptime | number | The lavalink node uptime, in seconds |
Defined in
PlayerState
Ƭ PlayerState: Object
Type declaration
| Name | Type | Description |
|---|---|---|
connected | boolean | Whether the player is connected to discord voice gateway |
position? | number | Track position in ms |
time | number | Unix timestamp when the position was picked |
Defined in
RoutePlannerDetails
Ƭ RoutePlannerDetails: Object
Type declaration
| Name | Type |
|---|---|
blockIndex? | string |
currentAddressIndex? | string |
failingAddresses | { address: string ; failingTime: string ; failingTimestamp: number }[] |
ipBlock | { size: string ; type: string } |
ipBlock.size | string |
ipBlock.type | string |
Defined in
RoutePlannerStatus
Ƭ RoutePlannerStatus: Object
Route planner API
Type declaration
| Name | Type |
|---|---|
class | string | null |
details | RoutePlannerDetails | null |
Defined in
TrackEndReason
Ƭ TrackEndReason: "FINISHED" | "LOAD_FAILED" | "STOPPED" | "REPLACED" | "CLEANUP"
Defined in
version
Ƭ version: string
Lavalink version