Class: Host
Information about the host environment.
Extends
BaseClient
Constructors
Constructor
new Host(
ctx?,_id?,_findUp?):Host
Constructor is used for internal usage only, do not create object from it.
Parameters
ctx?
Context
_id?
_findUp?
string
Returns
Host
Overrides
BaseClient.constructor
Methods
containerImage()
containerImage(
name):Container
Accesses a container image on the host.
Parameters
name
string
Name of the image to access.
Returns
directory()
directory(
path,opts?):Directory
Accesses a directory on the host.
Parameters
path
string
Location of the directory to access (e.g., ".").
opts?
Returns
file()
file(
path,opts?):File
Accesses a file on the host.
Parameters
path
string
Location of the file to retrieve (e.g., "README.md").
opts?
Returns
findUp()
findUp(
name,opts?):Promise<string>
Search for a file or directory by walking up the tree from system workdir. Return its relative path. If no match, return null
Parameters
name
string
name of the file or directory to search for
opts?
Returns
Promise<string>
id()
id():
Promise<ID>
A unique identifier for this Host.
Returns
Promise<ID>
service()
service(
ports,opts?):Service
Creates a service that forwards traffic to a specified address via the host.
Parameters
ports
Ports to expose via the service, forwarding through the host network.
If a port's frontend is unspecified or 0, it defaults to the same as the backend port.
An empty set of ports is not valid; an error will be returned.
opts?
Returns
tunnel()
tunnel(
service,opts?):Service
Creates a tunnel that forwards traffic from the host to a service.
Parameters
service
Service to send traffic from the tunnel.
opts?
Returns
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").