kui_shell_core.Arguments.md

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

Interface: Arguments<Options>

@kui-shell/core.Arguments

The full set of data passed to a command handler

Type parameters

Name	Type
Options	ParsedOptions

Hierarchy

• CommandLine<Options>

  ↳ Arguments

Table of contents

Properties

• REPL
• argv
• argvNoOptions
• block
• command
• createErrorStream
• createOutputStream
• execOptions
• nextBlock
• parsedOptions
• pipeStages
• tab

Properties

REPL

• REPL: REPL

Defined in

packages/core/src/models/command.ts:180

---

argv

• argv: string[]

the result of a whitespace split applied to the command string that pays attention to backslash escaping and quotations

Inherited from

CommandLine.argv

Defined in

packages/core/src/models/command.ts:146

---

argvNoOptions

• argvNoOptions: string[]

the residual of argv without parsedOptions

Inherited from

CommandLine.argvNoOptions

Defined in

packages/core/src/models/command.ts:151

---

block

• block: boolean | Block

EXPERT MODE: The REPL block in which this command was initiated (rarely used, but useful for more complex UI extensions)

Defined in

packages/core/src/models/command.ts:204

---

command

• command: string

the raw command string, as given by the user

Inherited from

CommandLine.command

Defined in

packages/core/src/models/command.ts:141

---

createErrorStream

• createErrorStream: StreamableFactory

Same as createOutputStream, but for stderr

Defined in

packages/core/src/models/command.ts:198

---

createOutputStream

• createOutputStream: StreamableFactory

Commands can use this to stream output to the UI, rather than using the normal request-response interaction between the REPL and the command.

Defined in

packages/core/src/models/command.ts:193

---

execOptions

• execOptions: ExecOptions

Optional command channel options that one command can use to influence the execution of another.

Defined in

packages/core/src/models/command.ts:186

---

nextBlock

• nextBlock: HTMLElement

EXPERT MODE: The REPL block that will house the subsequent command execution (rarely used, but useful for more complex UI extensions)

Defined in

packages/core/src/models/command.ts:211

---

parsedOptions

• parsedOptions: Options

the dash options parsed out in a way that pays attention to n-ary options such as --option key value

Inherited from

CommandLine.parsedOptions

Defined in

packages/core/src/models/command.ts:167

---

pipeStages

• pipeStages: Object

pipeline stages, e.g. if command='a b --foo|c', the pipeStages=[['a','b, '--foo'],'c']

Type declaration

Name	Type
prefix?	string
redirect?	string
redirector?	">" | ">>" | "2>&1" | ">&" | ">>&"
stages	string[][]

Inherited from

CommandLine.pipeStages

Defined in

packages/core/src/models/command.ts:156

---

tab

• tab: Tab

The tab context in which the command was initiated

Defined in

packages/core/src/models/command.ts:178