Class Terminal`Experimental`

Author

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

The Terminal class extends xterm.js to support ecmaOS-specific functionality.

Implements

Terminal

Hierarchy

Terminal
- Terminal

Index

Constructors

constructor

new Terminal(options?: TerminalOptions): Terminal
Experimental
Parameters
- options: TerminalOptions = DefaultTerminalOptions
Returns Terminal
Overrides XTerm.constructor
- Defined in core/kernel/src/tree/terminal.ts:162

Accessors

addons

get addons(): Map<string, ITerminalAddon>
Experimental
Get terminal addons

Returns Map<string, ITerminalAddon>
Implementation of ITerminal.addons
- Defined in core/kernel/src/tree/terminal.ts:145

ansi

get ansi(): __module
Experimental
Get ANSI escape sequences

Returns __module
Implementation of ITerminal.ansi
- Defined in core/kernel/src/tree/terminal.ts:146

cmd

get cmd(): string
Experimental
Get current command

Returns string
Implementation of ITerminal.cmd
- Defined in core/kernel/src/tree/terminal.ts:148

commands

get commands(): { [key: string]: TerminalCommand }
Experimental
Get terminal commands

Returns { [key: string]: TerminalCommand }
Implementation of ITerminal.commands
- Defined in core/kernel/src/tree/terminal.ts:147

cwd

get cwd(): string
Experimental
Get current working directory

Returns string
Implementation of ITerminal.cwd
- Defined in core/kernel/src/tree/terminal.ts:149

emojis

get emojis(): __module
Experimental
Get emoji utilities

Returns __module
Implementation of ITerminal.emojis
- Defined in core/kernel/src/tree/terminal.ts:150

events

get events(): Events
Experimental
Get event emitter

Returns Events
Implementation of ITerminal.events
- Defined in core/kernel/src/tree/terminal.ts:151

id

get id(): string
Experimental
Get terminal ID

Returns string
Implementation of ITerminal.id
- Defined in core/kernel/src/tree/terminal.ts:152

promptTemplate

get promptTemplate(): string
Experimental
Get/set prompt template

Returns string
Implementation of ITerminal.promptTemplate
- Defined in core/kernel/src/tree/terminal.ts:159
set promptTemplate(value: string): void
Experimental
Get/set prompt template
Parameters
- value: string
Returns void
Implementation of ITerminal.promptTemplate
- Defined in core/kernel/src/tree/terminal.ts:160

socket

get socket(): undefined | WebSocket
Experimental
Get WebSocket connection

Returns undefined | WebSocket
Implementation of ITerminal.socket
- Defined in core/kernel/src/tree/terminal.ts:153

socketKey

get socketKey(): undefined | JsonWebKey
Experimental
Get socket public key

Returns undefined | JsonWebKey
Implementation of ITerminal.socketKey
- Defined in core/kernel/src/tree/terminal.ts:154

stderr

get stderr(): WritableStream<Uint8Array>
Experimental
Get standard error stream

Returns WritableStream<Uint8Array>
Implementation of ITerminal.stderr
- Defined in core/kernel/src/tree/terminal.ts:157

stdin

get stdin(): ReadableStream<Uint8Array>
Experimental
Get standard input stream

Returns ReadableStream<Uint8Array>
Implementation of ITerminal.stdin
- Defined in core/kernel/src/tree/terminal.ts:155

stdout

get stdout(): WritableStream<Uint8Array>
Experimental
Get standard output stream

Returns WritableStream<Uint8Array>
Implementation of ITerminal.stdout
- Defined in core/kernel/src/tree/terminal.ts:156

Methods

clearCommand

clearCommand(): string
Experimental
Clear terminal command

Returns string
Implementation of ITerminal.clearCommand
- Defined in core/kernel/src/tree/terminal.ts:679

connect

connect(socket: WebSocket): void
Experimental
Connect to WebSocket
Parameters
- socket: WebSocket
  WebSocket to connect
Returns void
Implementation of ITerminal.connect
- Defined in core/kernel/src/tree/terminal.ts:317

createSpecialLink

createSpecialLink(uri: string, text: string): string
Experimental
Create a special terminal link
Parameters
- uri: string
  Link URI
- text: string
  Link text
Returns string
Implementation of ITerminal.createSpecialLink
- Defined in core/kernel/src/tree/terminal.ts:313

getInputStream

getInputStream(): ReadableStream<Uint8Array>
Experimental
Get input stream

Returns ReadableStream<Uint8Array>
Implementation of ITerminal.getInputStream
- Defined in core/kernel/src/tree/terminal.ts:671

hide

hide(): void
Experimental
Hide terminal

Returns void
Implementation of ITerminal.hide
- Defined in core/kernel/src/tree/terminal.ts:309

keyHandler

keyHandler(
__namedParameters: { domEvent: KeyboardEvent; key: string },
): Promise<void>
Experimental
Parameters
- __namedParameters: { domEvent: KeyboardEvent; key: string }
Returns Promise<void>
- Defined in core/kernel/src/tree/terminal.ts:424

listen

listen(): void
Experimental
Start listening for input

Returns void
Implementation of ITerminal.listen
- Defined in core/kernel/src/tree/terminal.ts:321

mount

mount(element: HTMLElement): void
Experimental
Mount terminal to DOM element
Parameters
- element: HTMLElement
  Element to mount to
Returns void
Implementation of ITerminal.mount
- Defined in core/kernel/src/tree/terminal.ts:302

paste

paste(data?: string): Promise<void>
Experimental
Writes text to the terminal, performing the necessary transformations for pasted text.
Parameters
- Optionaldata: string
  The text to write to the terminal.
Returns Promise<void>
Implementation of ITerminal.paste
Overrides XTerm.paste
- Defined in core/kernel/src/tree/terminal.ts:415

prompt

prompt(text?: string): string
Experimental
Get terminal prompt
Parameters
- text: string = ...
  Prompt text
Returns string
Implementation of ITerminal.prompt
- Defined in core/kernel/src/tree/terminal.ts:403

readline

readline(prompt?: string, hide?: boolean, noListen?: boolean): Promise<string>
Experimental
Read a line of input
Parameters
- prompt: string = ''
  Input prompt
- hide: boolean = false
  Hide input
- noListen: boolean = false
  Don't auto-listen
Returns Promise<string>
Implementation of ITerminal.readline
- Defined in core/kernel/src/tree/terminal.ts:351

restoreCommand

restoreCommand(cmd: string): void
Experimental
Restore terminal command
Parameters
- cmd: string
  Command to restore
Returns void
Implementation of ITerminal.restoreCommand
- Defined in core/kernel/src/tree/terminal.ts:687

serialize

serialize(): null | string
Experimental
Returns null | string
- Defined in core/kernel/src/tree/terminal.ts:652

shortcutKeyHandler

shortcutKeyHandler(
__namedParameters: { domEvent: KeyboardEvent },
): Promise<void>
Experimental
Parameters
- __namedParameters: { domEvent: KeyboardEvent }
Returns Promise<void>
- Defined in core/kernel/src/tree/terminal.ts:333

show

show(): void
Experimental
Returns void
- Defined in core/kernel/src/tree/terminal.ts:657

spinner

spinner(spinner: SpinnerName, prefix?: string, suffix?: string): Spinner
Experimental
Create a spinner
Parameters
- spinner: SpinnerName
  Spinner type
- Optionalprefix: string
  Prefix text
- Optionalsuffix: string
  Suffix text
Returns Spinner
Implementation of ITerminal.spinner
- Defined in core/kernel/src/tree/terminal.ts:395

unlisten

unlisten(): void
Experimental
Stop listening for input

Returns void
Implementation of ITerminal.unlisten
- Defined in core/kernel/src/tree/terminal.ts:327

write

write(data: string | Uint8Array): void
Experimental
Write data to the terminal.
Parameters
- data: string | Uint8Array
  The data to write to the terminal. This can either be raw bytes given as Uint8Array from the pty or a string. Raw bytes will always be treated as UTF-8 encoded, string data as UTF-16.
Returns void
Implementation of ITerminal.write
Overrides XTerm.write
- Defined in core/kernel/src/tree/terminal.ts:661

writeln

writeln(data: string | Uint8Array): void
Experimental
Writes data to the terminal, followed by a break line character (\n).
Parameters
- data: string | Uint8Array
  The data to write to the terminal. This can either be raw bytes given as Uint8Array from the pty or a string. Raw bytes will always be treated as UTF-8 encoded, string data as UTF-16.
Returns void
Implementation of ITerminal.writeln
Overrides XTerm.writeln
- Defined in core/kernel/src/tree/terminal.ts:666

Class TerminalExperimental

Author

Implements

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Terminal

Accessors

addons

Returns Map<string, ITerminalAddon>

ansi

Returns __module

cmd

Returns string

commands

Returns { [key: string]: TerminalCommand }

cwd

Returns string

emojis

Returns __module

events

Returns Events

id

Returns string

promptTemplate

Returns string

Parameters

Returns void

socket

Returns undefined | WebSocket

socketKey

Returns undefined | JsonWebKey

stderr

Returns WritableStream<Uint8Array>

stdin

Returns ReadableStream<Uint8Array>

stdout

Returns WritableStream<Uint8Array>

Methods

clearCommand

Returns string

connect

Parameters

Returns void

createSpecialLink

Parameters

Returns string

getInputStream

Returns ReadableStream<Uint8Array>

hide

Returns void

keyHandler

Parameters

Returns Promise<void>

listen

Returns void

mount

Parameters

Returns void

paste

Parameters

Returns Promise<void>

prompt

Parameters

Returns string

readline

Parameters

Returns Promise<string>

restoreCommand

Parameters

Returns void

serialize

Returns null | string

shortcutKeyHandler

Parameters

Class Terminal`Experimental`