Skip to main content

Class: Terminal

An interactive terminal that clients can connect to.

Extends​

  • BaseClient

Constructors​

new Terminal()​

new Terminal(ctx?, _id?, _sync?): Terminal

Constructor is used for internal usage only, do not create object from it.

Parameters​

ctx?​

Context

_id?​

TerminalID

_sync?​

TerminalID

Returns​

Terminal

Overrides​

BaseClient.constructor

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>