Terminal
Terminal =
object
Defined in: terminal.ts:9
Terminal properties a rendering sink needs, injected rather than read from
process.stdout directly so the renderer stays portable and testable without
a pty. The Node adapter lives in @ac-kit/app-system.
Properties
Section titled “Properties”colorDepth
Section titled “colorDepth”colorDepth:
ColorDepth
Defined in: terminal.ts:28
Color depth supported by the terminal.
columns
Section titled “columns”columns:
number
Defined in: terminal.ts:18
Viewport width in columns. Load-bearing even outside a full-screen reporter: a live region wider than the viewport corrupts scrollback, so a renderer must clamp against it.
hyperlinks
Section titled “hyperlinks”hyperlinks:
boolean
Defined in: terminal.ts:34
Whether the terminal supports hyperlinks.
interactive
Section titled “interactive”interactive:
boolean
Defined in: terminal.ts:11
Whether the terminal is interactive (i.e., connected to a TTY).
resize
Section titled “resize”resize:
IEventDispatcher
Defined in: terminal.ts:37
Fires whenever columns/rows change.
rows:
number
Defined in: terminal.ts:25
Viewport height. Load-bearing even outside a full-screen reporter: a live region taller than the viewport corrupts scrollback, so a renderer must clamp against it.
unicode
Section titled “unicode”unicode:
boolean
Defined in: terminal.ts:31
Whether the terminal supports Unicode characters.
Methods
Section titled “Methods”clear()?
Section titled “clear()?”
optionalclear():void
Defined in: terminal.ts:51
Erases the screen and its scrollback. Present only when interactive.
Returns
Section titled “Returns”void
enterAltScreen()?
Section titled “enterAltScreen()?”
optionalenterAltScreen():void
Defined in: terminal.ts:43
Enter the alternate screen buffer. Present only on terminals that support it.
Returns
Section titled “Returns”void
exitAltScreen()?
Section titled “exitAltScreen()?”
optionalexitAltScreen():void
Defined in: terminal.ts:48
Exit the alternate screen buffer. Present only on terminals that support it.
Returns
Section titled “Returns”void