Skip to main content

Class: Host

Information about the host environment.

Extends​

  • BaseClient

Constructors​

new Host()​

new Host(parent?, _id?): Host

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

Parameters​

• parent?

• parent.ctx?: Context

• parent.queryTree?: QueryTree[]

• _id?: HostID

Returns​

Host

Overrides​

BaseClient.constructor

Methods​

directory()​

directory(path, opts?): Directory

Accesses a directory on the host.

Parameters​

• path: string

Location of the directory to access (e.g., ".").

• opts?: HostDirectoryOpts

Returns​

Directory

file()​

file(path): File

Accesses a file on the host.

Parameters​

• path: string

Location of the file to retrieve (e.g., "README.md").

Returns​

File

id()​

id(): Promise<HostID>

A unique identifier for this Host.

Returns​

Promise<HostID>

service()​

service(opts?): Service

Creates a service that forwards traffic to a specified address via the host.

Parameters​

• opts?: HostServiceOpts

Returns​

Service

setSecretFile()​

setSecretFile(name, path): Secret

Sets a secret given a user-defined name and the file path on the host, and returns the secret.

The file is limited to a size of 512000 bytes.

Parameters​

• name: string

The user defined name for this secret.

• path: string

Location of the file to set as a secret.

Returns​

Secret

tunnel()​

tunnel(service, opts?): Service

Creates a tunnel that forwards traffic from the host to a service.

Parameters​

• service: Service

Service to send traffic from the tunnel.

• opts?: HostTunnelOpts

Returns​

Service

unixSocket()​

unixSocket(path): Socket

Accesses a Unix socket on the host.

Parameters​

• path: string

Location of the Unix socket (e.g., "/var/run/docker.sock").

Returns​

Socket