CommandsMap
interface
Helper type that maps command names to their types. It is meant to be extended with module augmentation.
class MyCommand extends Command {
public execute( parameter: A ): B {
// ...
}
}
declare module '@ckeditor/ckeditor5-core' {
interface CommandsMap {
myCommand: MyCommand;
}
}
// Returns `MyCommand | undefined`.
const myCommand = editor.commands.get( 'myCommand' );
// Expects `A` type as parameter and returns `B`.
const value = editor.commands.execute( 'myCommand', new A() );
Copy code
Properties
module:core/commandcollection~CommandsMap#__index[0]module:core/commandcollection~CommandsMap#acceptAllSuggestionsmodule:core/commandcollection~CommandsMap#acceptSelectedSuggestionsmodule:core/commandcollection~CommandsMap#acceptSuggestionmodule:core/commandcollection~CommandsMap#alignmentmodule:core/commandcollection~CommandsMap#blockQuotemodule:core/commandcollection~CommandsMap#boldmodule:core/commandcollection~CommandsMap#bulletedListmodule:core/commandcollection~CommandsMap#caseChangemodule:core/commandcollection~CommandsMap#checkTodoListmodule:core/commandcollection~CommandsMap#ckboxmodule:core/commandcollection~CommandsMap#ckboxImageEditmodule:core/commandcollection~CommandsMap#ckfindermodule:core/commandcollection~CommandsMap#codemodule:core/commandcollection~CommandsMap#codeBlockmodule:core/commandcollection~CommandsMap#copyFormatmodule:core/commandcollection~CommandsMap#deletemodule:core/commandcollection~CommandsMap#deleteForwardmodule:core/commandcollection~CommandsMap#discardAllSuggestionsmodule:core/commandcollection~CommandsMap#discardSelectedSuggestionsmodule:core/commandcollection~CommandsMap#discardSuggestionmodule:core/commandcollection~CommandsMap#editSourcemodule:core/commandcollection~CommandsMap#emojimodule:core/commandcollection~CommandsMap#entermodule:core/commandcollection~CommandsMap#exportInlineStylesmodule:core/commandcollection~CommandsMap#exportPdfmodule:core/commandcollection~CommandsMap#exportWordmodule:core/commandcollection~CommandsMap#findmodule:core/commandcollection~CommandsMap#findNextmodule:core/commandcollection~CommandsMap#findPreviousmodule:core/commandcollection~CommandsMap#fontBackgroundColormodule:core/commandcollection~CommandsMap#fontColormodule:core/commandcollection~CommandsMap#fontFamilymodule:core/commandcollection~CommandsMap#fontSizemodule:core/commandcollection~CommandsMap#goToNextRestrictedEditingExceptionmodule:core/commandcollection~CommandsMap#goToPreviousRestrictedEditingExceptionmodule:core/commandcollection~CommandsMap#headingmodule:core/commandcollection~CommandsMap#highlightmodule:core/commandcollection~CommandsMap#horizontalLinemodule:core/commandcollection~CommandsMap#htmlEmbedmodule:core/commandcollection~CommandsMap#imageStylemodule:core/commandcollection~CommandsMap#imageTextAlternativemodule:core/commandcollection~CommandsMap#imageTypeBlockmodule:core/commandcollection~CommandsMap#imageTypeInlinemodule:core/commandcollection~CommandsMap#importWordmodule:core/commandcollection~CommandsMap#indentBlockmodule:core/commandcollection~CommandsMap#indentCodeBlockmodule:core/commandcollection~CommandsMap#indentListmodule:core/commandcollection~CommandsMap#insertBookmarkmodule:core/commandcollection~CommandsMap#insertImagemodule:core/commandcollection~CommandsMap#insertMergeFieldmodule:core/commandcollection~CommandsMap#insertMergeFieldBlockmodule:core/commandcollection~CommandsMap#insertMergeFieldImagemodule:core/commandcollection~CommandsMap#insertParagraphmodule:core/commandcollection~CommandsMap#insertTablemodule:core/commandcollection~CommandsMap#insertTableColumnLeftmodule:core/commandcollection~CommandsMap#insertTableColumnRightmodule:core/commandcollection~CommandsMap#insertTableLayoutmodule:core/commandcollection~CommandsMap#insertTableOfContentsmodule:core/commandcollection~CommandsMap#insertTableRowAbovemodule:core/commandcollection~CommandsMap#insertTableRowBelowmodule:core/commandcollection~CommandsMap#insertTemplatemodule:core/commandcollection~CommandsMap#insertTextmodule:core/commandcollection~CommandsMap#italicmodule:core/commandcollection~CommandsMap#linkmodule:core/commandcollection~CommandsMap#listReversedmodule:core/commandcollection~CommandsMap#listStartmodule:core/commandcollection~CommandsMap#listStylemodule:core/commandcollection~CommandsMap#mediaEmbedmodule:core/commandcollection~CommandsMap#mentionmodule:core/commandcollection~CommandsMap#mergeListItemBackwardmodule:core/commandcollection~CommandsMap#mergeListItemForwardmodule:core/commandcollection~CommandsMap#mergeTableCellDownmodule:core/commandcollection~CommandsMap#mergeTableCellLeftmodule:core/commandcollection~CommandsMap#mergeTableCellRightmodule:core/commandcollection~CommandsMap#mergeTableCellUpmodule:core/commandcollection~CommandsMap#mergeTableCellsmodule:core/commandcollection~CommandsMap#numberedListmodule:core/commandcollection~CommandsMap#outdentBlockmodule:core/commandcollection~CommandsMap#outdentCodeBlockmodule:core/commandcollection~CommandsMap#outdentListmodule:core/commandcollection~CommandsMap#pageBreakmodule:core/commandcollection~CommandsMap#paragraphmodule:core/commandcollection~CommandsMap#pasteFormatmodule:core/commandcollection~CommandsMap#previewFinalContentmodule:core/commandcollection~CommandsMap#previewMergeFieldsmodule:core/commandcollection~CommandsMap#redomodule:core/commandcollection~CommandsMap#removeFormatmodule:core/commandcollection~CommandsMap#removeTableColumnmodule:core/commandcollection~CommandsMap#removeTableRowmodule:core/commandcollection~CommandsMap#replacemodule:core/commandcollection~CommandsMap#replaceAllmodule:core/commandcollection~CommandsMap#replaceImageSourcemodule:core/commandcollection~CommandsMap#replaceSourcemodule:core/commandcollection~CommandsMap#resizeImagerestoreRevision : RestoreRevisionCommandmodule:core/commandcollection~CommandsMap#restoreRevisionmodule:core/commandcollection~CommandsMap#restrictedEditingExceptionmodule:core/commandcollection~CommandsMap#selectAllmodule:core/commandcollection~CommandsMap#selectTableColumnmodule:core/commandcollection~CommandsMap#selectTableRowmodule:core/commandcollection~CommandsMap#setTableColumnHeadermodule:core/commandcollection~CommandsMap#setTableRowHeadermodule:core/commandcollection~CommandsMap#shiftEntermodule:core/commandcollection~CommandsMap#showAIAssistantmodule:core/commandcollection~CommandsMap#showBlocksshowNextChange : ShowChangeCommand<'forward'>module:core/commandcollection~CommandsMap#showNextChangeshowPreviousChange : ShowChangeCommand<'backward'>module:core/commandcollection~CommandsMap#showPreviousChangemodule:core/commandcollection~CommandsMap#splitListItemAftermodule:core/commandcollection~CommandsMap#splitListItemBeforemodule:core/commandcollection~CommandsMap#splitTableCellHorizontallymodule:core/commandcollection~CommandsMap#splitTableCellVerticallymodule:core/commandcollection~CommandsMap#strikethroughmodule:core/commandcollection~CommandsMap#stylemodule:core/commandcollection~CommandsMap#subscriptmodule:core/commandcollection~CommandsMap#superscriptmodule:core/commandcollection~CommandsMap#tableAlignmentmodule:core/commandcollection~CommandsMap#tableBackgroundColormodule:core/commandcollection~CommandsMap#tableBorderColormodule:core/commandcollection~CommandsMap#tableBorderStylemodule:core/commandcollection~CommandsMap#tableBorderWidthmodule:core/commandcollection~CommandsMap#tableCellBackgroundColormodule:core/commandcollection~CommandsMap#tableCellBorderColormodule:core/commandcollection~CommandsMap#tableCellBorderStylemodule:core/commandcollection~CommandsMap#tableCellBorderWidthmodule:core/commandcollection~CommandsMap#tableCellHeightmodule:core/commandcollection~CommandsMap#tableCellHorizontalAlignmentmodule:core/commandcollection~CommandsMap#tableCellPaddingmodule:core/commandcollection~CommandsMap#tableCellVerticalAlignmentmodule:core/commandcollection~CommandsMap#tableCellWidthmodule:core/commandcollection~CommandsMap#tableHeightmodule:core/commandcollection~CommandsMap#tableTypemodule:core/commandcollection~CommandsMap#tableWidthmodule:core/commandcollection~CommandsMap#textPartLanguagemodule:core/commandcollection~CommandsMap#todoListmodule:core/commandcollection~CommandsMap#toggleAImodule:core/commandcollection~CommandsMap#toggleFullscreenmodule:core/commandcollection~CommandsMap#toggleImageCaptionmodule:core/commandcollection~CommandsMap#toggleTableCaptionmodule:core/commandcollection~CommandsMap#trackChangesmodule:core/commandcollection~CommandsMap#underlinemodule:core/commandcollection~CommandsMap#undomodule:core/commandcollection~CommandsMap#unlinkmodule:core/commandcollection~CommandsMap#updateBookmarkmodule:core/commandcollection~CommandsMap#uploadImagemodule:core/commandcollection~CommandsMap#uploadcaremodule:core/commandcollection~CommandsMap#uploadcareImageEdit