Commands Class

Provides access to Cantabile's UI commands

Access this object via the Cantabile#commands property.

class Commands extends EndPoint {
    availableCommands(): Promise<CommandInfo[]>;
    invoke(id: string): Promise<void>;
}

#Methods

#availableCommands()

Retrieves a list of available commands

If Cantabile is running on your local machine you can view this list directly at http://localhost:35007/api/commands/availableCommands

availableCommands(): Promise<CommandInfo[]>;

Example

console.log(await C.commands.availableCommands());

#invoke()

Invokes a command

invoke(id: string): Promise<void>;

• id The id of the command to invoke

Example

// Show the file open dialog
C.commands.invoke("file.open");