​yajsapi / Exports / executor/events / CommandStarted

Class: CommandStarted

​executor/events.CommandStarted

Hierarchy

• ​CommandEvent​

  ↳ CommandStarted

Table of contents

Constructors

• ​constructor​

Properties

• ​agr_id​

• ​cmd_idx​

• ​command​

• ​task_id​

Methods

• ​extract_exc_info​

Constructors

constructor

• new CommandStarted(__namedParameters: Object): CommandStarted​

Parameters:

• __namedParameters: Object

Returns: CommandStarted​

Inherited from: CommandEvent​

Defined in: yajsapi/executor/events.ts:312​

Properties

agr_id

• Optional agr_id: undefined | string

Inherited from: CommandEvent.agr_id​

Defined in: yajsapi/executor/events.ts:123​

cmd_idx

• cmd_idx: number

Inherited from: CommandEvent.cmd_idx​

Defined in: yajsapi/executor/events.ts:312​

command

• command: string

Defined in: yajsapi/executor/events.ts:443​

task_id

• Optional task_id: undefined | null | string

Inherited from: CommandEvent.task_id​

Defined in: yajsapi/executor/events.ts:282​

Methods

extract_exc_info

▸ extract_exc_info(): [undefined | null | Error, YaEvent]

Extract exception information from this event.

Returns: [undefined | null | Error, YaEvent]

The extracted exception information and a copy of the event without the exception information.

Inherited from: CommandEvent​

Defined in: yajsapi/executor/events.ts:17​