Skip to main content

Class: Port

A port exposed by a container.

Extends​

  • BaseClient

Constructors​

new Port()​

new Port(ctx?, _id?, _description?, _experimentalSkipHealthcheck?, _port?, _protocol?): Port

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

Parameters​

ctx?​

Context

_id?​

PortID

_description?​

string

_experimentalSkipHealthcheck?​

boolean

_port?​

number

_protocol?​

NetworkProtocol

Returns​

Port

Overrides​

BaseClient.constructor

Methods​

description()​

description(): Promise<string>

The port description.

Returns​

Promise<string>

experimentalSkipHealthcheck()​

experimentalSkipHealthcheck(): Promise<boolean>

Skip the health check when run as a service.

Returns​

Promise<boolean>

id()​

id(): Promise<PortID>

A unique identifier for this Port.

Returns​

Promise<PortID>

port()​

port(): Promise<number>

The port number.

Returns​

Promise<number>

protocol()​

protocol(): Promise<NetworkProtocol>

The transport layer protocol.

Returns​

Promise<NetworkProtocol>