Interface: ICommandService

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/services/command/command.service.ts:185

The service to register and execute commands.

Methods

beforeCommandExecuted()

beforeCommandExecuted(listener): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/services/command/command.service.ts:235

Parameters

Parameter	Type
`listener`	`CommandListener`

Returns

IDisposable

executeCommand()

executeCommand<P, R>(
   id, 
   params?, 
options?): Promise<R>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/services/command/command.service.ts:213

Execute a command with the given id and parameters.

Type Parameters

Type Parameter	Default type
`P` extends `object`	`object`
`R`	`boolean`

Parameters

Parameter	Type	Description
`id`	`string`	Identifier of the command.
`params`?	`P`	Parameters of this execution.
`options`?	`IExecutionOptions`	Options of this execution.

Returns

Promise<R>

The result of the execution. It is a boolean value by default which indicates the command is executed.

hasCommand()

hasCommand(commandId): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/services/command/command.service.ts:195

Check if a command is already registered at the current command service.

Parameters

Parameter	Type	Description
`commandId`	`string`	The id of the command.

Returns

boolean

If the command is registered, return true, otherwise return false.

onCommandExecuted()

onCommandExecuted(listener): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/services/command/command.service.ts:230

Parameters

Parameter	Type
`listener`	`CommandListener`

Returns

IDisposable

registerCommand()

registerCommand(command): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/services/command/command.service.ts:200

Parameters

Parameter	Type	Description
`command`	`ICommand`<`unknown`>	The command to register.

Returns

IDisposable

registerMultipleCommand()

registerMultipleCommand(command): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/services/command/command.service.ts:205

Parameters

Parameter	Type	Description
`command`	`ICommand`<`unknown`>	The command to register as a multi command.

Returns

IDisposable

syncExecuteCommand()

syncExecuteCommand<P, R>(
   id, 
   params?, 
   options?): R

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/services/command/command.service.ts:225

Execute a command with the given id and parameters synchronously.

Type Parameters

Type Parameter	Default type
`P` extends `object`	`object`
`R`	`boolean`

Parameters

Parameter	Type	Description
`id`	`string`	Identifier of the command.
`params`?	`P`	Parameters of this execution.
`options`?	`IExecutionOptions`	Options of this execution.

Returns

R

The result of the execution. It is a boolean value by default which indicates the command is executed.

Icommandinfo Iconfigservice