Class Shell`Experimental`

Author

Jay Mathis code@mathis.network (https://github.com/mathiscode)

The Shell class handles the Terminal environment and interaction with the Kernel.

Implements

Shell

Index

Constructors

Accessors

credentials cwd env envObject id kernel terminal username

Methods

attach clearPositionalParameters execute setPositionalParameters

Constructors

constructor

new Shell(_options: ShellOptions): Shell
Experimental
Parameters
- _options: ShellOptions
Returns Shell
- Defined in core/kernel/src/tree/shell.ts:56

Accessors

credentials

get credentials(): Credentials
Experimental
Current user's credentials

Returns Credentials
Implementation of IShell.credentials
- Defined in core/kernel/src/tree/shell.ts:53
set credentials(cred: Credentials): void
Experimental
Current user's credentials
Parameters
- cred: Credentials
Returns void
Implementation of IShell.credentials
- Defined in core/kernel/src/tree/shell.ts:54

cwd

get cwd(): string
Experimental
Current working directory

Returns string
Implementation of IShell.cwd
- Defined in core/kernel/src/tree/shell.ts:43
set cwd(path: string): void
Experimental
Current working directory
Parameters
- path: string
Returns void
Implementation of IShell.cwd
- Defined in core/kernel/src/tree/shell.ts:44

env

get env(): Map<string, string>
Experimental
Environment variables

Returns Map<string, string>
Implementation of IShell.env
- Defined in core/kernel/src/tree/shell.ts:45
set env(env: Map<string, string>): void
Experimental
Environment variables
Parameters
- env: Map<string, string>
Returns void
Implementation of IShell.env
- Defined in core/kernel/src/tree/shell.ts:46

envObject

get envObject(): { [k: string]: string }
Experimental
Environment variables as object

Returns { [k: string]: string }
Implementation of IShell.envObject
- Defined in core/kernel/src/tree/shell.ts:47

id

get id(): string
Experimental
Shell ID

Returns string
Implementation of IShell.id
- Defined in core/kernel/src/tree/shell.ts:48

kernel

get kernel(): Kernel
Experimental
Returns Kernel
- Defined in core/kernel/src/tree/shell.ts:49

terminal

get terminal(): Terminal
Experimental
Returns Terminal
- Defined in core/kernel/src/tree/shell.ts:50

username

get username(): string
Experimental
Current username

Returns string
Implementation of IShell.username
- Defined in core/kernel/src/tree/shell.ts:51

Methods

attach

attach(terminal: Terminal): void
Experimental
Attach terminal to shell
Parameters
- terminal: Terminal
  Terminal to attach
Returns void
Implementation of IShell.attach
- Defined in core/kernel/src/tree/shell.ts:70

clearPositionalParameters

clearPositionalParameters(): void
Experimental
Clear positional parameters

Returns void
Implementation of IShell.clearPositionalParameters
- Defined in core/kernel/src/tree/shell.ts:75

execute

execute(line: string): Promise<number>
Experimental
Execute a command
Parameters
- line: string
  Command line to execute
Returns Promise<number>
Implementation of IShell.execute
- Defined in core/kernel/src/tree/shell.ts:98

setPositionalParameters

setPositionalParameters(args: string[]): void
Experimental
Set positional parameters
Parameters
- args: string[]
  Arguments to set
Returns void
Implementation of IShell.setPositionalParameters
- Defined in core/kernel/src/tree/shell.ts:257