v0.0.1-beta

Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / Musicord

Class Musicord

Defined in Musicord.ts

Constructor

constructor(options?: MusicordOptionsinterface MusicordOptionsutils/MusicordOptions)

Create a new Musicord

· options - Musicord options

Properties

readonly options: MusicordOptionsinterface MusicordOptionsutils/MusicordOptions | {} = {}[src]
readonly queue: Mapexternal Map<string, QueueOptionsinterface QueueOptionsutils/QueueOptions> = Mapexternal Map[src]

Methods

get version(): string[src]

Musicord version

initQueue(
guild: Guild,
options: InitQueueOptionsinterface InitQueueOptionsutils/InitQueueOptions
): Playerclass Playerstructures/Player[src]

Initializes a new queue if it does not exist. Update the queue if it already exists.

· guild - Message guild
· options - Options to init queue (required)

Returns

An audio player
deleteQueue(guild: Guild): void[src]

Deletes the queue for this guild

· guild - The queue guild

Returns

Void
existQueue(guild: Guild): boolean[src]

Chekcks if a queue exists

· guild - The queue guild

Returns

Boolean
getQueue(guild: Guild): Playerclass Playerstructures/Player | undefined[src]

Gets a specific queue

· guild - The queue guild

Returns

Player|undefined
getQueueInfo(guild: Guild): QueueOptionsinterface QueueOptionsutils/QueueOptions | undefined[src]

Gets queue infos

· guild - The queue guild

Returns

QueueOptions|undefined
private _generateQueueSchema(
guild: Guild,
options: InitQueueOptionsinterface InitQueueOptionsutils/InitQueueOptions
): QueueOptionsinterface QueueOptionsutils/QueueOptions[src]

Generates what will be stored in the queue.

· guild - The queue guild
· options - Options to init the queue

Returns

QueueOptions