Class CommandExecutor

提供命令注册与执行的实现。

class
version: 1.0.0

Hierarchy

CommandExecutor

Implements

ICommandExecutor

Index

Constructors

constructor

Properties

Accessors

default

Methods

Constructors

constructor

new CommandExecutor(parser?: ICommandExpressionParser): CommandExecutor

- Defined in commands/command-executor.ts:53
初始化命令执行器的新实例。

constructor

Parameters
- Optional parser: ICommandExpressionParser
  
  命令行文本解析
Returns CommandExecutor

Properties

Private _commands

_commands: CommandCollection

Private _parser

_parser: ICommandExpressionParser

Static Private _default

_default: CommandExecutor

Accessors

Static default

get default(): CommandExecutor
set default(value: CommandExecutor): void

- Defined in commands/command-executor.ts:29
获取或设置默认的命令执行器。

static

property

Returns CommandExecutor

CommandExecutor
- Defined in commands/command-executor.ts:45
获取或设置默认的命令执行器。

static

property

Parameters
- value: CommandExecutor
Returns void

CommandExecutor

Methods

Protected createCommandContext

createCommandContext(expression: CommandExpression, command: ICommand, parameter: any): CommandContext

- Defined in commands/command-executor.ts:246
创建命令上下文实例。

virtual

Parameters
- expression: CommandExpression
- command: ICommand
- parameter: any
Returns CommandContext

CommandContext

Protected createExecutorContext

createExecutorContext(commandText: string, parameter: any): CommandExecutorContext

- Defined in commands/command-executor.ts:224
创建命令执行上下文实例。

virtual

Parameters
- commandText: string
- parameter: any
Returns CommandExecutorContext

CommandExecutorContext

execute

execute(commandText: string, parameter?: any): Promise<any>

Implementation of ICommandExecutor.execute
- Defined in commands/command-executor.ts:106
执行命令。

summary

暂不支持表达式，commandText 仅为命令路径。

async

Parameters
- commandText: string
  
  指定要执行的命令表达式文本。
- Default value parameter: any = null
  
  指定的输入参数。
Returns Promise<any>

any 返回命令执行的结果。

Protected executeCommand

executeCommand(context: CommandExecutorContext, expression: CommandExpression, command: ICommand, parameter: any): Promise<any>

- Defined in commands/command-executor.ts:199
执行命令。

virtual

async

Parameters
- context: CommandExecutorContext
- expression: CommandExpression
- command: ICommand
- parameter: any
Returns Promise<any>

any

find

find(path: string): ICommand

- Defined in commands/command-executor.ts:93
查找指定路径的命令。

Parameters
- path: string
  
  路径字符串。
Returns ICommand

ICommand

Protected onExecute

onExecute(context: CommandExecutorContext): Promise<any>

- Defined in commands/command-executor.ts:144
当执行命令时调用。

async

Parameters
- context: CommandExecutorContext
  
  命令执行上下文。
Returns Promise<any>

any

Protected onParse

onParse(text: string): CommandExpression

- Defined in commands/command-executor.ts:258
当解析命令表达式时调用。

virtual

Parameters
- text: string
Returns CommandExpression

CommandExpression

register

register(path: string, command: ICommand): void

- Defined in commands/command-executor.ts:73
注册一个命令。注意: 如果路径已存在，则会抛出一个异常。

Parameters
- path: string
  
  命令路径。
- command: ICommand
  
  命令实例。
Returns void

void

remove

remove(path: string): boolean

- Defined in commands/command-executor.ts:83
移除指定路径的命令。

Parameters
- path: string
Returns boolean

boolean

Generated using TypeDoc