@univerjs/sheets-thread-comment v0.1.17 • Docs
Interface: ICommandService
Methods
beforeCommandExecuted()
beforeCommandExecuted(listener): IDisposableRegister a callback function that will be executed before a command is executed.
Parameters
| Parameter | Type |
|---|---|
listener | CommandListener |
Returns
IDisposable
Defined in
packages/core/src/services/command/command.service.ts:163 (opens in a new tab)
executeCommand()
executeCommand<P, R>(
id,
params?,
options?): Promise<R>Type Parameters
| Type Parameter | Default type |
|---|---|
P extends object | object |
R | boolean |
Parameters
| Parameter | Type |
|---|---|
id | string |
params? | P |
options? | IExecutionOptions |
Returns
Promise<R>
Defined in
packages/core/src/services/command/command.service.ts:144 (opens in a new tab)
hasCommand()
hasCommand(commandId)
hasCommand(commandId): booleanCheck if a command is already registered at the current command service.
Parameters
| Parameter | Type | Description |
|---|---|---|
commandId | string | The id of the command. |
Returns
boolean
Defined in
packages/core/src/services/command/command.service.ts:138 (opens in a new tab)
hasCommand(id)
hasCommand(id): booleanParameters
| Parameter | Type |
|---|---|
id | string |
Returns
boolean
Defined in
packages/core/src/services/command/command.service.ts:150 (opens in a new tab)
onCommandExecuted()
onCommandExecuted(listener): IDisposableRegister a callback function that will be executed after a command is executed.
Parameters
| Parameter | Type |
|---|---|
listener | CommandListener |
Returns
IDisposable
Defined in
packages/core/src/services/command/command.service.ts:157 (opens in a new tab)
registerCommand()
registerCommand(command): IDisposableParameters
| Parameter | Type |
|---|---|
command | ICommand<object, unknown> |
Returns
IDisposable
Defined in
packages/core/src/services/command/command.service.ts:140 (opens in a new tab)
registerMultipleCommand()
registerMultipleCommand(command): IDisposableParameters
| Parameter | Type |
|---|---|
command | ICommand<object, unknown> |
Returns
IDisposable
Defined in
packages/core/src/services/command/command.service.ts:142 (opens in a new tab)
syncExecuteCommand()
syncExecuteCommand<P, R>(
id,
params?,
options?): RType Parameters
| Type Parameter | Default type |
|---|---|
P extends object | object |
R | boolean |
Parameters
| Parameter | Type |
|---|---|
id | string |
params? | P |
options? | IExecutionOptions |
Returns
R
Defined in
packages/core/src/services/command/command.service.ts:152 (opens in a new tab)