Class CommandCollection

Collection of commands. Its instance is available in module:core/editor/editor~Editor#commands editor.commands.

Implements

Iterable<[string, Command]>

Index

Constructors

Methods

[iterator] add commands destroy execute get names

Constructors

constructor

new CommandCollection(): CommandCollection
Creates collection instance.

Returns CommandCollection
- Defined in node_modules/@ckeditor/ckeditor5-core/src/commandcollection.d.ts:17

Methods

[iterator]

"[iterator]"(): Iterator<[string, Command]>
Iterable interface.

Returns [ commandName, commandInstance ] pairs.

Returns Iterator<[string, Command]>
Implementation of Iterable.[iterator]
- Defined in node_modules/@ckeditor/ckeditor5-core/src/commandcollection.d.ts:51

add

add<TName extends string>(commandName: TName, command: CommandsMap[TName]): void
Registers a new command.
Type Parameters
- TName extends string
Parameters
- commandName: TName
  The name of the command.
- command: CommandsMap[TName]
Returns void
- Defined in node_modules/@ckeditor/ckeditor5-core/src/commandcollection.d.ts:23

commands

commands(): IterableIterator<Command>
Returns iterator of command instances.

Returns IterableIterator<Command>
- Defined in node_modules/@ckeditor/ckeditor5-core/src/commandcollection.d.ts:45

destroy

destroy(): void
Destroys all collection commands.

Returns void
- Defined in node_modules/@ckeditor/ckeditor5-core/src/commandcollection.d.ts:55

execute

execute<TName extends string>(
commandName: TName,
...commandParams: Parameters<CommandsMap[TName]["execute"]>,
): ReturnType<CommandsMap[TName]["execute"]>
Executes a command.
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 module:core/command~Command#execute command.execute().
- Defined in node_modules/@ckeditor/ckeditor5-core/src/commandcollection.d.ts:37

get

get<TName extends string>(commandName: TName): CommandsMap[TName]
Retrieves a command from the collection.
Type Parameters
- TName extends string
Parameters
- commandName: TName
  The name of the command.
Returns CommandsMap[TName]
- Defined in node_modules/@ckeditor/ckeditor5-core/src/commandcollection.d.ts:29

names

names(): IterableIterator<string>
Returns iterator of command names.

Returns IterableIterator<string>
- Defined in node_modules/@ckeditor/ckeditor5-core/src/commandcollection.d.ts:41