Class

CommandCollection (core)

@ckeditor/ckeditor5-core/src/commandcollection

class

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

Filtering

Properties

Methods

  • constructor()

    Creates collection instance.

  • Symbol.iterator() → Iterator<tuple, any, undefined>

    Iterable interface.

    Returns [ commandName, commandInstance ] pairs.

    Returns

    Iterator<tuple, any, undefined>
  • add( commandName, command ) → void

    Registers a new command.

    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.

    Returns

    IterableIterator<Command>
  • destroy() → void

    Destroys all collection commands.

    Returns

    void
  • execute( commandName, commandParams ) → 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 command.execute().

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

    Retrieves a command from the collection.

    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.

    Returns

    IterableIterator<string>