actionbase

@listenai/lisa_core / Exports / ActionBase

Class: ActionBase

Table of contents

Constructors

• constructor

Properties

• std
• stdmockOrigs
• stdmocks
• type

Accessors

• globals
• output
• running
• status
• task

Methods

• _flushStdout
• _pause
• _resume
• _start
• _stdout
• _stop
• _updateStatus
• _write
• pause
• pauseAsync
• start
• stop

Constructors

constructor

• new ActionBase()

Properties

std

• std: "stdout" | "stderr"

Defined in

node_modules/cli-ux/lib/action/base.d.ts:12

---

stdmockOrigs

• Private stdmockOrigs: any

Defined in

node_modules/cli-ux/lib/action/base.d.ts:14

---

stdmocks

• Protected Optional stdmocks: ["stdout" | "stderr", string[]][]

Defined in

node_modules/cli-ux/lib/action/base.d.ts:13

---

type

• type: ActionType

Defined in

node_modules/cli-ux/lib/action/base.d.ts:11

Accessors

globals

• Private get globals(): any

Returns

any

Defined in

node_modules/cli-ux/lib/action/base.d.ts:17

---

output

• Protected get output(): undefined | string

Returns

undefined | string

Defined in

node_modules/cli-ux/lib/action/base.d.ts:20

• Protected set output(output): void

Parameters

Name	Type
output	undefined | string

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:21

---

running

• get running(): boolean

Returns

boolean

Defined in

node_modules/cli-ux/lib/action/base.d.ts:22

---

status

• get status(): undefined | string

Returns

undefined | string

Defined in

node_modules/cli-ux/lib/action/base.d.ts:23

• set status(status): void

Parameters

Name	Type
status	undefined | string

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:24

---

task

• get task(): undefined | ITask

Returns

undefined | ITask

Defined in

node_modules/cli-ux/lib/action/base.d.ts:18

• set task(task): void

Parameters

Name	Type
task	undefined | ITask

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:19

Methods

_flushStdout

▸ Protected _flushStdout(): void

flush mocked stdout/stderr

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:39

---

_pause

▸ Protected _pause(_?): void

Parameters

Name	Type
_?	string

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:30

---

_resume

▸ Protected _resume(): void

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:29

---

_start

▸ Protected _start(): void

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:27

---

_stdout

▸ Protected _stdout(toggle): void

mock out stdout/stderr so it doesn't screw up the rendering

Parameters

Name	Type
toggle	boolean

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:35

---

_stop

▸ Protected _stop(_): void

Parameters

Name	Type
_	string

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:28

---

_updateStatus

▸ Protected _updateStatus(_, __?): void

Parameters

Name	Type
_	undefined | string
__?	string

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:31

---

_write

▸ Protected _write(std, s): void

write to the real stdout/stderr

Parameters

Name	Type
std	"stdout" | "stderr"
s	string | string[]

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:43

---

pause

▸ pause(fn, icon?): any

Parameters

Name	Type
fn	() => any
icon?	string

Returns

any

Defined in

node_modules/cli-ux/lib/action/base.d.ts:26

---

pauseAsync

▸ pauseAsync(fn, icon?): Promise<any>

Parameters

Name	Type
fn	() => Promise<any>
icon?	string

Returns

Promise<any>

Defined in

node_modules/cli-ux/lib/action/base.d.ts:25

---

start

▸ start(action, status?, opts?): void

Parameters

Name	Type
action	string
status?	string
opts?	Options

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:15

---

stop

▸ stop(msg?): void

Parameters

Name	Type
msg?	string

Returns

void

Defined in

node_modules/cli-ux/lib/action/base.d.ts:16