TypeScript SDK Reference
api/client.gen.Terminal
An interactive terminal that clients can connect to.
Hierarchy
-
BaseClient
↳
Terminal
Constructors
constructor
new Terminal(parent?
, _id?
, _sync?
): Terminal
Constructor is used for internal usage only, do not create object from it.
Parameters
Name | Type |
---|---|
parent? | Object |
parent.ctx | Context |
parent.queryTree? | QueryTree [] |
_id? | TerminalID |
_sync? | TerminalID |
Returns
Overrides
BaseClient.constructor
Properties
_id
Private
Optional
Readonly
_id: TerminalID
= undefined
_sync
Private
Optional
Readonly
_sync: TerminalID
= undefined
Methods
id
id(): Promise
<TerminalID
>
A unique identifier for this Terminal.
Returns
Promise
<TerminalID
>
sync
sync(): Promise
<Terminal
>
Forces evaluation of the pipeline in the engine.
It doesn't run the default command if no exec has been set.
Returns
Promise
<Terminal
>