kui_shell_core.ExecOptions.md

Kui API Documentation - v11.0.0 / @kui-shell/core / ExecOptions

Interface: ExecOptions

@kui-shell/core.ExecOptions

Table of contents

Properties

• alreadyWatching
• block
• container
• contextChangeOK
• createErrorStream
• createOnly
• createOutputStream
• credentials
• custom
• cwd
• data
• delegationOk
• echo
• entity
• env
• exec
• execUUID
• failWithUsage
• filter
• history
• insertIdx
• intentional
• isDrilldown
• isProxied
• leaveBottomStripeAlone
• nested
• nextBlock
• noCoreRedirect
• noDelegation
• noHeader
• noHistory
• noRetry
• noSidecarHeader
• noStatus
• parameters
• pip
• pipeStdin
• placeholder
• preserveBackButton
• quiet
• raw
• rawResponse
• render
• replSilence
• reportErrors
• rethrowErrors
• showHeader
• tab
• type
• watch

Methods

• onExit
• onInit
• onReady
• stderr
• stdout

Properties

alreadyWatching

• Optional alreadyWatching: boolean

Defined in

packages/core/src/models/execOptions.ts:89

---

block

• Optional block: Block

Defined in

packages/core/src/models/execOptions.ts:61

---

container

• Optional container: Element

Defined in

packages/core/src/models/execOptions.ts:81

---

contextChangeOK

• Optional contextChangeOK: boolean

Defined in

packages/core/src/models/execOptions.ts:55

---

createErrorStream

• Optional createErrorStream: StreamableFactory

Defined in

packages/core/src/models/execOptions.ts:92

---

createOnly

• Optional createOnly: boolean

Defined in

packages/core/src/models/execOptions.ts:83

---

createOutputStream

• Optional createOutputStream: StreamableFactory

Defined in

packages/core/src/models/execOptions.ts:93

---

credentials

• Optional credentials: Record<string, any>

Defined in

packages/core/src/models/execOptions.ts:56

---

custom

• Optional custom: any

Defined in

packages/core/src/models/execOptions.ts:58

---

cwd

• Optional cwd: string

cwd?

Defined in

packages/core/src/models/execOptions.ts:40

---

data

• Optional data: string | number | Buffer | Record<string, any>

pass through uninterpreted data

Defined in

packages/core/src/models/execOptions.ts:31

---

delegationOk

• Optional delegationOk: boolean

Defined in

packages/core/src/models/execOptions.ts:50

---

echo

• Optional echo: boolean

Defined in

packages/core/src/models/execOptions.ts:71

---

entity

• Optional entity: any

Defined in

packages/core/src/models/execOptions.ts:108

---

env

• Optional env: Record<string, string>

environment variable map

Defined in

packages/core/src/models/execOptions.ts:43

---

exec

• Optional exec: "pexec" | "qexec" | "rexec"

Defined in

packages/core/src/models/execOptions.ts:79

---

execUUID

• Optional execUUID: string

execution UUID

Defined in

packages/core/src/models/execOptions.ts:28

---

failWithUsage

• Optional failWithUsage: boolean

Defined in

packages/core/src/models/execOptions.ts:73

---

filter

• Optional filter: any

Defined in

packages/core/src/models/execOptions.ts:54

---

history

• Optional history: number

Defined in

packages/core/src/models/execOptions.ts:70

---

insertIdx

• Optional insertIdx: number

Defined in

packages/core/src/models/execOptions.ts:90

---

intentional

• Optional intentional: boolean

Defined in

packages/core/src/models/execOptions.ts:66

---

isDrilldown

• Optional isDrilldown: boolean

Defined in

packages/core/src/models/execOptions.ts:60

---

isProxied

• Optional isProxied: boolean

Defined in

packages/core/src/models/execOptions.ts:48

---

leaveBottomStripeAlone

• Optional leaveBottomStripeAlone: boolean

Defined in

packages/core/src/models/execOptions.ts:52

---

nested

• Optional nested: boolean

Defined in

packages/core/src/models/execOptions.ts:72

---

nextBlock

• Optional nextBlock: HTMLElement

Defined in

packages/core/src/models/execOptions.ts:62

---

noCoreRedirect

• Optional noCoreRedirect: boolean

Defined in

packages/core/src/models/execOptions.ts:68

---

noDelegation

• Optional noDelegation: boolean

Defined in

packages/core/src/models/execOptions.ts:49

---

noHeader

• Optional noHeader: boolean

Defined in

packages/core/src/models/execOptions.ts:84

---

noHistory

• Optional noHistory: boolean

Defined in

packages/core/src/models/execOptions.ts:67

---

noRetry

• Optional noRetry: boolean

Defined in

packages/core/src/models/execOptions.ts:87

---

noSidecarHeader

• Optional noSidecarHeader: boolean

Defined in

packages/core/src/models/execOptions.ts:86

---

noStatus

• Optional noStatus: boolean

Defined in

packages/core/src/models/execOptions.ts:85

---

parameters

• Optional parameters: any

Defined in

packages/core/src/models/execOptions.ts:107

---

pip

• Optional pip: Object

Type declaration

Name	Type
container	string
returnTo	string

Defined in

packages/core/src/models/execOptions.ts:69

---

pipeStdin

• Optional pipeStdin: boolean

Defined in

packages/core/src/models/execOptions.ts:96

---

placeholder

• Optional placeholder: string

Defined in

packages/core/src/models/execOptions.ts:63

---

preserveBackButton

• Optional preserveBackButton: boolean

Defined in

packages/core/src/models/execOptions.ts:76

---

quiet

• Optional quiet: boolean

Defined in

packages/core/src/models/execOptions.ts:65

---

raw

• Optional raw: boolean

Defined in

packages/core/src/models/execOptions.ts:82

---

rawResponse

• Optional rawResponse: boolean

Defined in

packages/core/src/models/execOptions.ts:59

---

render

• Optional render: boolean

true, if you wish a qexec to return rendered HTML; default is false, meaning you get the model back on qexec

Defined in

packages/core/src/models/execOptions.ts:46

---

replSilence

• Optional replSilence: boolean

Defined in

packages/core/src/models/execOptions.ts:64

---

reportErrors

• Optional reportErrors: boolean

Defined in

packages/core/src/models/execOptions.ts:75

---

rethrowErrors

• Optional rethrowErrors: boolean

Defined in

packages/core/src/models/execOptions.ts:74

---

showHeader

• Optional showHeader: boolean

Defined in

packages/core/src/models/execOptions.ts:88

---

tab

• Optional tab: Tab

force execution in a given tab?

Defined in

packages/core/src/models/execOptions.ts:25

---

type

• Optional type: ExecType

Defined in

packages/core/src/models/execOptions.ts:77

---

watch

• Optional watch: Object

pass watch state variables to subcommands being watched

Type declaration

Name	Type
accumulator	Record<string, any>
iteration	number

Defined in

packages/core/src/models/execOptions.ts:34

Methods

onExit

▸ Optional onExit(exitCode): void

on job exit, pass the exitCode

Parameters

Name	Type
exitCode	number

Returns

void

Defined in

packages/core/src/models/execOptions.ts:105

---

onInit

▸ Optional onInit(job): Stream | Promise<Stream>

on job init, pass the job, and get back a stdout; i.e. just before the PTY is brought up

Parameters

Name	Type
job	Job

Returns

Stream | Promise<Stream>

Defined in

packages/core/src/models/execOptions.ts:99

---

onReady

▸ Optional onReady(job): void | Promise<void>

on job ready, i.e. after the PTY is up, but before any data has been processed

Parameters

Name	Type
job	Job

Returns

void | Promise<void>

Defined in

packages/core/src/models/execOptions.ts:102

---

stderr

▸ Optional stderr(str): any

Parameters

Name	Type
str	string

Returns

any

Defined in

packages/core/src/models/execOptions.ts:95

---

stdout

▸ Optional stdout(str): any

Parameters

Name	Type
str	Streamable

Returns

any

Defined in

packages/core/src/models/execOptions.ts:94