CommandManager
Class: CommandManager
Section titled “Class: CommandManager”Defined in: command.svelte.ts:316
Extends
Section titled “Extends”EventDispatcher<{executed: [Command];hotkeys-updated: [object];register: [Command];unregister: [Command]; }>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CommandManager(
app):CommandManager
Defined in: command.svelte.ts:335
Parameters
Section titled “Parameters”Returns
Section titled “Returns”CommandManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlyapp:App
Defined in: command.svelte.ts:335
bindings
Section titled “bindings”
readonlybindings:Record<string,Command[]>
Defined in: command.svelte.ts:332
commands
Section titled “commands”
readonlycommands:Record<string,Command>
Defined in: command.svelte.ts:330
editorCommands
Section titled “editorCommands”
readonlyeditorCommands:Record<string,Command>
Defined in: command.svelte.ts:331
hotkeyOverrides
Section titled “hotkeyOverrides”
readonlyhotkeyOverrides:Record<string,Hotkey[]>
Defined in: command.svelte.ts:333
open:
boolean
Defined in: command.svelte.ts:327
openHostId
Section titled “openHostId”openHostId:
string
Defined in: command.svelte.ts:328
Methods
Section titled “Methods”addHotkey()
Section titled “addHotkey()”addHotkey(
commandId,hotkey):Promise<void>
Defined in: command.svelte.ts:525
Parameters
Section titled “Parameters”commandId
Section titled “commandId”string
hotkey
Section titled “hotkey”Returns
Section titled “Returns”Promise<void>
commandsFor()
Section titled “commandsFor()”commandsFor(
key):Command[]
Defined in: command.svelte.ts:763
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Command[]
dispatch()
Section titled “dispatch()”dispatch<
T>(eventName, …args):boolean
Defined in: events.ts:105
Type Parameters
Section titled “Type Parameters”T extends "register" | "unregister" | "executed" | "hotkeys-updated"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<{ executed: [Command]; hotkeys-updated: [object]; register: [Command]; unregister: [Command]; }>[Extract<T, "register" | "unregister" | "executed" | "hotkeys-updated">]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”emit()
Section titled “emit()”emit<
T>(eventName, …args):boolean
Defined in: events.ts:98
Type Parameters
Section titled “Type Parameters”T extends "register" | "unregister" | "executed" | "hotkeys-updated"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<{ executed: [Command]; hotkeys-updated: [object]; register: [Command]; unregister: [Command]; }>[Extract<T, "register" | "unregister" | "executed" | "hotkeys-updated">]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”executeCommand()
Section titled “executeCommand()”executeCommand<
T>(id, …rest):Promise<T>
Defined in: command.svelte.ts:730
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
…any[]
Returns
Section titled “Returns”Promise<T>
executeCommandForHost()
Section titled “executeCommandForHost()”executeCommandForHost<
T>(id,hostId, …rest):Promise<T>
Defined in: command.svelte.ts:734
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
hostId
Section titled “hostId”string
…any[]
Returns
Section titled “Returns”Promise<T>
getAllCommandMetadata()
Section titled “getAllCommandMetadata()”getAllCommandMetadata():
CommandMetadata[]
Defined in: command.svelte.ts:772
Returns
Section titled “Returns”CommandMetadata[]
getAllCommands()
Section titled “getAllCommands()”getAllCommands():
Command[]
Defined in: command.svelte.ts:768
Returns
Section titled “Returns”Command[]
getAvailableCommandMetadata()
Section titled “getAvailableCommandMetadata()”getAvailableCommandMetadata(
hostId?):CommandMetadata[]
Defined in: command.svelte.ts:670
Parameters
Section titled “Parameters”hostId?
Section titled “hostId?”string = ...
Returns
Section titled “Returns”CommandMetadata[]
getAvailableCommands()
Section titled “getAvailableCommands()”getAvailableCommands(
hostId?):Command[]
Defined in: command.svelte.ts:664
Parameters
Section titled “Parameters”hostId?
Section titled “hostId?”string = ...
Returns
Section titled “Returns”Command[]
getCommand()
Section titled “getCommand()”getCommand(
id):Command|undefined
Defined in: command.svelte.ts:622
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Command | undefined
getCommandMetadata()
Section titled “getCommandMetadata()”getCommandMetadata(
id):CommandMetadata|undefined
Defined in: command.svelte.ts:626
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”CommandMetadata | undefined
getDefaultHotkeys()
Section titled “getDefaultHotkeys()”getDefaultHotkeys(
commandId):Hotkey[]
Defined in: command.svelte.ts:498
Parameters
Section titled “Parameters”commandId
Section titled “commandId”string
Returns
Section titled “Returns”Hotkey[]
getEffectiveHotkeys()
Section titled “getEffectiveHotkeys()”getEffectiveHotkeys(
commandId):Hotkey[]
Defined in: command.svelte.ts:504
Parameters
Section titled “Parameters”commandId
Section titled “commandId”string
Returns
Section titled “Returns”Hotkey[]
getHotkeyAssignments()
Section titled “getHotkeyAssignments()”getHotkeyAssignments():
HotkeyAssignment[]
Defined in: command.svelte.ts:552
Returns
Section titled “Returns”getHotkeyConflicts()
Section titled “getHotkeyConflicts()”getHotkeyConflicts():
HotkeyConflict[]
Defined in: command.svelte.ts:562
Returns
Section titled “Returns”hide()
Section titled “hide()”hide(
hostId?):void
Defined in: command.svelte.ts:747
Parameters
Section titled “Parameters”hostId?
Section titled “hostId?”string
Returns
Section titled “Returns”void
isCommandAvailable()
Section titled “isCommandAvailable()”isCommandAvailable(
id,hostId?):boolean
Defined in: command.svelte.ts:631
Parameters
Section titled “Parameters”string
hostId?
Section titled “hostId?”string = ...
Returns
Section titled “Returns”boolean
isHotkeyCustomized()
Section titled “isHotkeyCustomized()”isHotkeyCustomized(
commandId):boolean
Defined in: command.svelte.ts:511
Parameters
Section titled “Parameters”commandId
Section titled “commandId”string
Returns
Section titled “Returns”boolean
isOpenForHost()
Section titled “isOpenForHost()”isOpenForHost(
hostId):boolean
Defined in: command.svelte.ts:346
Parameters
Section titled “Parameters”hostId
Section titled “hostId”string
Returns
Section titled “Returns”boolean
loadHotkeys()
Section titled “loadHotkeys()”loadHotkeys():
Promise<void>
Defined in: command.svelte.ts:454
Returns
Section titled “Returns”Promise<void>
off<
T>(eventName,listener,context?,once?):void
Defined in: events.ts:78
Type Parameters
Section titled “Type Parameters”T extends "register" | "unregister" | "executed" | "hotkeys-updated"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”offref()
Section titled “offref()”offref<
T>(ref):void
Defined in: events.ts:87
Type Parameters
Section titled “Type Parameters”T extends "register" | "unregister" | "executed" | "hotkeys-updated"
Parameters
Section titled “Parameters”EventRef<{ executed: [Command]; hotkeys-updated: [object]; register: [Command]; unregister: [Command]; }, T>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”on<
T>(eventName,listener,context?):EventRef<{executed: [Command];hotkeys-updated: [object];register: [Command];unregister: [Command]; },T,any>
Defined in: events.ts:48
Type Parameters
Section titled “Type Parameters”T extends "register" | "unregister" | "executed" | "hotkeys-updated"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
Returns
Section titled “Returns”EventRef<{ executed: [Command]; hotkeys-updated: [object]; register: [Command]; unregister: [Command]; }, T, any>
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once<
T>(eventName,listener,context?):EventRef<{executed: [Command];hotkeys-updated: [object];register: [Command];unregister: [Command]; },T,any>
Defined in: events.ts:63
Type Parameters
Section titled “Type Parameters”T extends "register" | "unregister" | "executed" | "hotkeys-updated"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
Returns
Section titled “Returns”EventRef<{ executed: [Command]; hotkeys-updated: [object]; register: [Command]; unregister: [Command]; }, T, any>
Inherited from
Section titled “Inherited from”registerCommand()
Section titled “registerCommand()”registerCommand(
command):void
Defined in: command.svelte.ts:591
Parameters
Section titled “Parameters”command
Section titled “command”Returns
Section titled “Returns”void
removeHotkey()
Section titled “removeHotkey()”removeHotkey(
commandId,hotkey):Promise<void>
Defined in: command.svelte.ts:532
Parameters
Section titled “Parameters”commandId
Section titled “commandId”string
hotkey
Section titled “hotkey”Returns
Section titled “Returns”Promise<void>
resetHotkeys()
Section titled “resetHotkeys()”resetHotkeys(
commandId):Promise<void>
Defined in: command.svelte.ts:542
Parameters
Section titled “Parameters”commandId
Section titled “commandId”string
Returns
Section titled “Returns”Promise<void>
saveHotkeys()
Section titled “saveHotkeys()”saveHotkeys():
Promise<void>
Defined in: command.svelte.ts:473
Returns
Section titled “Returns”Promise<void>
setHotkeys()
Section titled “setHotkeys()”setHotkeys(
commandId,hotkeys):Promise<void>
Defined in: command.svelte.ts:515
Parameters
Section titled “Parameters”commandId
Section titled “commandId”string
hotkeys
Section titled “hotkeys”Hotkey[]
Returns
Section titled “Returns”Promise<void>
show()
Section titled “show()”show(
hostId?):void
Defined in: command.svelte.ts:742
Parameters
Section titled “Parameters”hostId?
Section titled “hostId?”string = ...
Returns
Section titled “Returns”void
toggle()
Section titled “toggle()”toggle(
hostId?):void
Defined in: command.svelte.ts:754
Parameters
Section titled “Parameters”hostId?
Section titled “hostId?”string = ...
Returns
Section titled “Returns”void
trigger()
Section titled “trigger()”trigger<
T>(eventName, …args):boolean
Defined in: events.ts:91
Type Parameters
Section titled “Type Parameters”T extends "register" | "unregister" | "executed" | "hotkeys-updated"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<{ executed: [Command]; hotkeys-updated: [object]; register: [Command]; unregister: [Command]; }>[Extract<T, "register" | "unregister" | "executed" | "hotkeys-updated">]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”tryTrigger()
Section titled “tryTrigger()”tryTrigger<
T>(evt, …args):void
Defined in: events.ts:112
Type Parameters
Section titled “Type Parameters”T extends "register" | "unregister" | "executed" | "hotkeys-updated"
Parameters
Section titled “Parameters”EventRef<{ executed: [Command]; hotkeys-updated: [object]; register: [Command]; unregister: [Command]; }, T>
…ArgumentMap<{ executed: [Command]; hotkeys-updated: [object]; register: [Command]; unregister: [Command]; }>[Extract<T, "register" | "unregister" | "executed" | "hotkeys-updated">]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unregisterCommand()
Section titled “unregisterCommand()”unregisterCommand(
id):boolean
Defined in: command.svelte.ts:605
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean