@types/LavaShark

Table of contents

Type Aliases

• EventListeners
• IncomingDiscordPayload
• LavaSharkOptions
• Metadata
• OutgoingDiscordPayload
• SEARCH_SOURCE
• SpotifyConfig
• UNRESOLVED_SOURCES
• VoiceServerUpdateData
• VoiceServerUpdatePayload
• VoiceStateUpdatePayload

Type Aliases

EventListeners

Type declaration

Event	listener
debug	message: string
raw	node: Node, payload: unknown
nodeConnect	node: Node
nodeResume	node: Node
nodeDisconnect	node: Node, code: number, reason: string
warn	node: Node, warn: string
error	node: Node, error: Error
trackAdd	player: Player, tracks: Track | Array<Track>
trackStart	player: Player, track: Track
trackEnd	player: Player, track: Track, reason: TrackEndReason
trackStuck	player: Player, track: Track, thresholdMs: number
trackException	player: Player, track: default | Track, exception: LoadException & { cause: string }
playerCreate	player: Player
playerDestroy	player: Player
playerDisconnect	player: Player, code: number, reason: string
queueEnd	player: Player
pong	node: Node, buffer: Buffer

Type parameters

Name
T

Type declaration

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"debug"
listener	(message: string) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"raw"
listener	(node: Node, payload: unknown) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"nodeConnect"
listener	(node: Node) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"nodeResume"
listener	(node: Node) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"nodeDisconnect"
listener	(node: Node, code: number, reason: string) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"warn"
listener	(node: Node, warn: string) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"error"
listener	(node: Node, error: Error) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"trackAdd"
listener	(player: Player, tracks: Track | Track[]) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"trackStart"
listener	(player: Player, track: Track) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"trackEnd"
listener	(player: Player, track: Track, reason: TrackEndReason) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"trackStuck"
listener	(player: Player, track: Track, thresholdMs: number) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"trackException"
listener	(player: Player, track: default | Track, exception: LoadException & { cause: string }) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"playerConnect"
listener	(player: Player) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"playerCreate"
listener	(player: Player) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"playerDestroy"
listener	(player: Player) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"playerDisconnect"
listener	(player: Player, code: number, reason: string) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"queueEnd"
listener	(player: Player) => void

Returns

T

▸ (event, listener): T

LavaShark events

Parameters

Name	Type
event	"pong"
listener	(node: Node, buffer: Buffer) => void

Returns

T

Defined in

@types/LavaShark.types.ts:45

---

IncomingDiscordPayload

Ƭ IncomingDiscordPayload: Object

Type declaration

Name	Type
d?	unknown
op	number
s?	number
t?	string

Defined in

@types/LavaShark.types.ts:9

---

LavaSharkOptions

Ƭ LavaSharkOptions: Object

Main constructor options

Type declaration

Name	Type	Description
defaultSearchSource?	SEARCH_SOURCE	The default source to search for tracks
disabledSources?	UNRESOLVED_SOURCES[]	Disables spotify, apple music or deezer
nodes	NodeOptions[]	The array of lavalink nodes
sendWS	(guildId: string, payload: OutgoingDiscordPayload) => void	Function to send voice channel connect payloads to discord
spotify?	SpotifyConfig	The spotify credentials
unresolvedSearchSource?	SEARCH_SOURCE	The default source to search for unresolved tracks
useISRC?	boolean	Whether to search for ISRC to resolve tracks or not

Defined in

@types/LavaShark.types.ts:81

---

Metadata

Ƭ Metadata: Pick<TrackInfo, "title" | "author" | "uri"> & { duration: Timestamp ; isrc?: string ; source: string }

Defined in

@types/LavaShark.types.ts:37

---

OutgoingDiscordPayload

Ƭ OutgoingDiscordPayload: Object

Type declaration

Name	Type
d	Record<string, unknown>
op	number

Defined in

@types/LavaShark.types.ts:65

---

SEARCH_SOURCE

Ƭ SEARCH_SOURCE: "youtube" | "youtubemusic" | "soundcloud"

Defined in

@types/LavaShark.types.ts:70

---

SpotifyConfig

Ƭ SpotifyConfig: Object

Type declaration

Name	Type
clientId	string
clientSecret	string
market?	string

Defined in

@types/LavaShark.types.ts:74

---

UNRESOLVED_SOURCES

Ƭ UNRESOLVED_SOURCES: "APPLE_MUSIC" | "DEEZER" | "SPOTIFY"

Defined in

@types/LavaShark.types.ts:72

---

VoiceServerUpdateData

Ƭ VoiceServerUpdateData: Object

Type declaration

Name	Type
endpoint	string
guild_id	string
token	string

Defined in

@types/LavaShark.types.ts:26

---

VoiceServerUpdatePayload

Ƭ VoiceServerUpdatePayload: IncomingDiscordPayload & { d: VoiceServerUpdateData ; t: "VOICE_SERVER_UPDATE" }

Defined in

@types/LavaShark.types.ts:32

---

VoiceStateUpdatePayload

Ƭ VoiceStateUpdatePayload: IncomingDiscordPayload & { d: { channel_id: string | null ; guild_id: string ; session_id: string ; user_id: string } ; t: "VOICE_STATE_UPDATE" }

Defined in

@types/LavaShark.types.ts:16