executor_events.commandevent.md

Class: CommandEvent

yajsapi / Exports / executor/events / CommandEvent

Class: CommandEvent

executor/events.CommandEvent

Hierarchy

• ScriptEvent

  ↳ CommandEvent

  ↳↳ CommandExecuted

  ↳↳ CommandStarted

  ↳↳ CommandStdOut

  ↳↳ CommandStdErr

Table of contents

Constructors

• constructor

Properties

• agr_id
• cmd_idx
• task_id

Methods

• extract_exc_info

Constructors

constructor

• new CommandEvent(__namedParameters)

Parameters

Name	Type
__namedParameters	Object

Overrides

ScriptEvent.constructor

Defined in

yajsapi/executor/events.ts:314

Properties

agr_id

• Optional agr_id: string

Inherited from

ScriptEvent.agr_id

Defined in

yajsapi/executor/events.ts:123

cmd_idx

• cmd_idx: number

Defined in

yajsapi/executor/events.ts:314

task_id

• Optional task_id: null | string

Inherited from

ScriptEvent.task_id

Defined in

yajsapi/executor/events.ts:284

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

ScriptEvent.extract_exc_info

Defined in

yajsapi/executor/events.ts:17