teraslice-cli / helpers/display / default
Class: default
Defined in: teraslice-cli/src/helpers/display.ts:72
Constructors
Constructor
new default():
Display
Returns
Display
Methods
confirmTap()
confirmTap(
size,target,yes?):Promise<boolean>
Defined in: teraslice-cli/src/helpers/display.ts:255
Prompts for confirmation before a tap that could return a large response (size of 'all', 0 or more than 50 records). Resolves true when no prompt is needed or the user confirms.
Parameters
| Parameter | Type |
|---|---|
size | string | undefined |
target | string |
yes? | boolean |
Returns
Promise<boolean>
display()
display(
header,items,type,active?,parse?,id?):Promise<void>
Defined in: teraslice-cli/src/helpers/display.ts:141
Display teraslice responses in a table
Parameters
| Parameter | Type | Description |
|---|---|---|
header | any | Header values to include in output |
items | any | Teraslice client response object |
type | string | Output table type |
active? | boolean | Set to true use values in active list |
parse? | boolean | Set to true to parse response |
id? | string | id value used to filter results by job_id or ex_id |
Returns
Promise<void>
parseResponse()
parseResponse(
header,response,active?,id?):any[]
Defined in: teraslice-cli/src/helpers/display.ts:84
Parses the teraslice client endpoint responses into an array used to generate tables in command line output.
Parameters
| Parameter | Type | Description |
|---|---|---|
header | any[] | Header values to include in output |
response | Record<string, any> | Teraslice client response object |
active? | boolean | When set to true parse values in active list |
id? | string | id value used to filter results by job_id or ex_id |
Returns
any[]
Table content is an array of arrays with each row an element in the array.
setAction()
setAction(
action,tense):UpdateActions
Defined in: teraslice-cli/src/helpers/display.ts:268
Parameters
| Parameter | Type |
|---|---|
action | Action |
tense | Tense |
Returns
showPrompt()
showPrompt(
action,message?):Promise<boolean>
Defined in: teraslice-cli/src/helpers/display.ts:238
Parameters
| Parameter | Type | Default value |
|---|---|---|
action | string | undefined |
message | string | '' |
Returns
Promise<boolean>