Skip to main content

Dagger NodeJS SDK

api/client.gen.Terminal

An interactive terminal that clients can connect to.

Hierarchy​

  • BaseClient

    ↳ Terminal

Constructors​

constructor​

new Terminal(parent?, _id?, _websocketEndpoint?): Terminal

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

Parameters​

NameType
parent?Object
parent.ctxContext
parent.queryTree?QueryTree[]
_id?TerminalID
_websocketEndpoint?string

Returns​

Terminal

Overrides​

BaseClient.constructor

Properties​

_id​

Private Optional Readonly _id: TerminalID = undefined

_websocketEndpoint​

Private Optional Readonly _websocketEndpoint: string = undefined

Methods​

id​

id(): Promise<TerminalID>

A unique identifier for this Terminal.

Returns​

Promise<TerminalID>

websocketEndpoint​

websocketEndpoint(): Promise<string>

An http endpoint at which this terminal can be connected to over a websocket.

Returns​

Promise<string>