CommandCollection

class

Collection of commands. Its instance is available in editor.commands.

See source

Properties

Methods

constructor()

Creates collection instance.
See source (with github icon)
Symbol.iterator() → Iterator<tuple>

Iterable interface.
Returns [ commandName, commandInstance ] pairs.
See source (with github icon)
Returns
Iterator<tuple>
add( commandName, command ) → void

Registers a new command.
See source (with github icon)
Type parameters
TName : extends string
Parameters
commandName : TName
The name of the command.
command : CommandsMap[ TName ]
Returns
void
commands() → IterableIterator<Command>

Returns iterator of command instances.
See source (with github icon)
Returns
IterableIterator<Command>
destroy() → void

Destroys all collection commands.
See source (with github icon)
Returns
void
execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>

Executes a command.
See source (with github icon)
Type parameters
TName : extends string
Parameters
commandName : TName
The name of the command.
commandParams : Parameters<CommandsMap[ TName ][ 'execute' ]>
Command parameters.
Returns
ReturnType<CommandsMap[ TName ][ 'execute' ]>
The value returned by the command.execute().
get( commandName ) → undefined | CommandsMap[ TName ]

Retrieves a command from the collection.
See source (with github icon)
Type parameters
TName : extends string
Parameters
commandName : TName
The name of the command.
Returns
undefined | CommandsMap[ TName ]
names() → IterableIterator<string>

Returns iterator of command names.
See source (with github icon)
Returns
IterableIterator<string>

CommandCollection

Properties

`_commands : Map<string, Command>`
private

Methods

`constructor()`

`Symbol.iterator() → Iterator<tuple>`

Returns

`add( commandName, command ) → void`

Type parameters

Parameters

Returns

`commands() → IterableIterator<Command>`

Returns

`destroy() → void`

Returns

`execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>`

Type parameters

Parameters

Returns

`get( commandName ) → undefined | CommandsMap[ TName ]`

Type parameters

Parameters

Returns

`names() → IterableIterator<string>`

Returns

CommandCollection

Properties

_commands : Map<string, Command> Lock iconprivate

Methods

constructor()

Symbol.iterator() → Iterator<tuple>

Returns

add( commandName, command ) → void

Type parameters

Parameters

Returns

commands() → IterableIterator<Command>

Returns

destroy() → void

Returns

execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>

Type parameters

Parameters

Returns

get( commandName ) → undefined | CommandsMap[ TName ]

Type parameters

Parameters

Returns

names() → IterableIterator<string>

Returns

`_commands : Map<string, Command>`
private

`constructor()`

`Symbol.iterator() → Iterator<tuple>`

`add( commandName, command ) → void`

`commands() → IterableIterator<Command>`

`destroy() → void`

`execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>`

`get( commandName ) → undefined | CommandsMap[ TName ]`

`names() → IterableIterator<string>`