Interface XTermInterface

XTerm interfacing object.

Hierarchy

XTermInterface

Index

Constructors

constructor

Properties

color
term

Accessors

Methods

Constructors

constructor

new XTermInterface(term: any, color: any, wnd: StandardWindow): any

- Defined in apis/util/cli.d.ts:74
Creates a new XTI.

Parameters
- term: any
  
  Xterm terminal [external]
- color: any
  
  Color [external]
- wnd: StandardWindow
  
  The window to use.
Returns any

Properties

color

color: any

[external] Color.

term

term: any

[external] XTerm terminal.

Accessors

hasNewLine

get hasNewLine(): boolean

- Defined in apis/util/cli.d.ts:94
Has new line?

Returns boolean

lastChars

get lastChars(): string

- Defined in apis/util/cli.d.ts:89
Gets the last chars.

Returns string

Methods

clear

clear(): void

- Defined in apis/util/cli.d.ts:153
Clears the terminal

Returns void

escapeANSI

escapeANSI(text: string): string

- Defined in apis/util/cli.d.ts:159
Escapes ANSI text.

Parameters
- text: string
  
  The text to escape.
Returns string

onData

onData(): void

- Defined in apis/util/cli.d.ts:164
[internal]

Returns void

pause

pause(): Promise<void>

- Defined in apis/util/cli.d.ts:148
Pauses the terminal.

Returns Promise<void>

print

print(text: string, opts?: TermWriteOpts): void

- Defined in apis/util/cli.d.ts:115
Prints text.

Parameters
- text: string
  
  The text to print.
- Optional opts: TermWriteOpts
  
  The options to use.
Returns void

printError

printError(text: string, opts?: TermWriteOpts): void

- Defined in apis/util/cli.d.ts:136
Prints an error.

Parameters
- text: string
  
  The text to print.
- Optional opts: TermWriteOpts
  
  The options to use.
Returns void

println

println(text: string, opts?: TermWriteOpts): void

- Defined in apis/util/cli.d.ts:122
Prints text (with newline).

Parameters
- text: string
  
  The text to print.
- Optional opts: TermWriteOpts
  
  The options to use.
Returns void

printlnEscaped

printlnEscaped(text: string, opts?: TermWriteOpts): void

- Defined in apis/util/cli.d.ts:129
Prints text (escaped, with newline).

Parameters
- text: string
  
  The text to print.
- Optional opts: TermWriteOpts
  
  The options to use.
Returns void

prompt

prompt(question: string, allowCtrlC?: boolean): Promise<void>

- Defined in apis/util/cli.d.ts:143
Creates a prompt.

Parameters
- question: string
  
  The question to ask.
- Optional allowCtrlC: boolean
  
  Whether to allow CTRL+C to break out of it. Default = false.
Returns Promise<void>

write

write(text: string, opts?: TermWriteOpts): void

- Defined in apis/util/cli.d.ts:101
Prints text.

Parameters
- text: string
  
  The text to print.
- Optional opts: TermWriteOpts
  
  The options to use.
Returns void

writeln

writeln(text: string, opts?: TermWriteOpts): void

- Defined in apis/util/cli.d.ts:108
Prints text (with newline).

Parameters
- text: string
  
  The text to print.
- Optional opts: TermWriteOpts
  
  The options to use.
Returns void

Generated using TypeDoc