Pseudoterminal class

Defines the interface of a terminal pty, enabling extensions to control a terminal.

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

Pseudoterminal.new({Event<String>? onDidWrite, Event<TerminalDimensions?>? onDidOverrideDimensions, Event<Object>? onDidClose, Event<String>? onDidChangeName, void open([TerminalDimensions?])?, void close()?, void handleInput(String)?, void setDimensions(TerminalDimensions)?})
factory

Properties

close ↔ void Function()

Available on Pseudoterminal, provided by the Pseudoterminal$Typings extension

getter/setter pair
handleInput ↔ void Function(String)

Available on Pseudoterminal, provided by the Pseudoterminal$Typings extension

getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
onDidChangeName Event<String>?

Available on Pseudoterminal, provided by the Pseudoterminal$Typings extension

An event that when fired allows changing the name of the terminal.
getter/setter pair
onDidClose Event<Object>?

Available on Pseudoterminal, provided by the Pseudoterminal$Typings extension

An event that when fired will signal that the pty is closed and dispose of the terminal.
getter/setter pair
onDidOverrideDimensions Event<TerminalDimensions?>?

Available on Pseudoterminal, provided by the Pseudoterminal$Typings extension

An event that when fired allows overriding the {@link Pseudoterminal.setDimensions dimensions} of the terminal. Note that when set, the overridden dimensions will only take effect when they are lower than the actual dimensions of the terminal (ie. there will never be a scroll bar). Set to undefined for the terminal to go back to the regular dimensions (fit to the size of the panel).
getter/setter pair
onDidWrite Event<String>

Available on Pseudoterminal, provided by the Pseudoterminal$Typings extension

An event that when fired will write data to the terminal. Unlike {@link Terminal.sendText} which sends text to the underlying child pseudo-device (the child), this will write the text to parent pseudo-device (the terminal itself).
getter/setter pair
open ↔ void Function([TerminalDimensions?])

Available on Pseudoterminal, provided by the Pseudoterminal$Typings extension

getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
setDimensions ↔ void Function(TerminalDimensions)

Available on Pseudoterminal, provided by the Pseudoterminal$Typings extension

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited