Class CommandBase<TContext>

提供实现 ICommand 接口功能的基类。

abstract
class
description: 建议需要完成 ICommand 接口功能的实现者从此类继承。
version: 1.0.0

Type parameters

TContext: CommandContext

Hierarchy

CommandBase

Implements

ICommand

Index

Constructors

constructor

Properties

Accessors

enabled
name

Methods

Constructors

constructor

new CommandBase(name?: string, enabled?: boolean): CommandBase

- Defined in commands/command-base.ts:59
初始化命令的新实例。

Parameters
- Default value name: string = ""
  
  命令名称。
- Default value enabled: boolean = true
  
  是否启用。
Returns CommandBase

Properties

Private _enabled

_enabled: boolean

Private _name

_name: string

Accessors

enabled

get enabled(): boolean
set enabled(value: boolean): void

- Defined in commands/command-base.ts:51
获取或设置当前命令是否可用。

summary

该属性作为当前命令是否可被执行的备选方案，命令是否可被执行由 canExecute 方法决定，该方法的不同实现方式可能导致不同的判断逻辑。有关默认的判断逻辑请参考 canExecute 方法的帮助。

property

Returns boolean

boolean
- Defined in commands/command-base.ts:56
获取或设置当前命令是否可用。

Parameters
- value: boolean
Returns void

boolean

name

get name(): string
set name(value: string): void

- Defined in commands/command-base.ts:24
获取或设置命令的名称。

property

Returns string

string
- Defined in commands/command-base.ts:29
获取或设置命令的名称。

Parameters
- value: string
Returns void

string

Methods

canExecute

canExecute(context: TContext): boolean

- Defined in commands/command-base.ts:80
判断当前命令能否依据给定的选项和参数执行。

virtual

Parameters
- context: TContext
  
  判断命令能否执行的上下文对象。
Returns boolean

boolean 返回能否执行的结果。

execute

execute(context: TContext): Promise<any>

- Defined in commands/command-base.ts:93
执行命令。

summary

对实现着的要求：应该在本方法的实现中首先调用 canExecute 方法，以确保阻止非法的调用。

virtual

async

Parameters
- context: TContext
  
  执行命令的上下文对象。
Returns Promise<any>

any 返回执行的返回结果。

Protected Abstract onExecute

onExecute(context: TContext): Promise<any>

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

abstract

async

Parameters
- context: TContext
  
  执行命令的上下文对象。
Returns Promise<any>

any 执行的返回结果。

Generated using TypeDoc