CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

CommandCollection (core)

@ckeditor/ckeditor5-core/src/commandcollection

class
See source

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

Filtering

Properties

  • _commands : Map

    private

    Command map.

    See source

Methods

  • constructor()

    Creates collection instance.

    See source

  • Symbol.iterator() → Iterable.<Array>

    Iterable interface.

    See source

    Returns [ commandName, commandInstance ] pairs.

    Returns

    Iterable.<Array>

  • add( commandName, command )

    Registers a new command.

    See source

    Parameters

    commandName : String

    The name of the command.

    command : Command

  • commands() → Iterable.<Command>

    Returns iterator of command instances.

    See source

    Returns

    Iterable.<Command>

  • destroy()

    Destroys all collection commands.

    See source

  • execute( commandName, [ ...commandParams ] ) → *

    Executes a command.

    See source

    Parameters

    commandName : String

    The name of the command.

    [ ...commandParams ] : *

    Command parameters.

    Returns

    *

    The value returned by the command.execute().

  • get( commandName ) → Command

    Retrieves a command from the collection.

    See source

    Parameters

    commandName : String

    The name of the command.

    Returns

    Command

  • names() → Iterable.<String>

    Returns iterator of command names.

    See source

    Returns

    Iterable.<String>