Interface Gateway

family

host

id

port

externalIp

• externalIp(options?): Promise<string>

• Find the external network IP address, usually an IPv4 class address.

  Parameters

  • Optional options: AbortOptions

  Returns Promise<string>

map

• map(internalPort, internalHost, options?): Promise<PortMapping>

• Map a local host:port pair to one on the external network interface

  If the mapping is successful, the external port number that was mapped is returned - this may be different from the requested port number if that port was not free.

  Parameters

  • internalPort: number
  • internalHost: string
  • Optional options: MapPortOptions

  Returns Promise<PortMapping>

mapAll

• mapAll(internalPort, options?): AsyncGenerator<PortMapping, void, unknown>

• Try mapping the passed port using all eligible network interfaces on the current machine.

  Yields successful host:port pairs and will throw if no successful mapping occurs.

  Parameters

  • internalPort: number
  • Optional options: MapPortOptions

  Returns AsyncGenerator<PortMapping, void, unknown>

stop

• stop(options?): Promise<void>

• Stop all network transactions and unmap any mapped ports

  Parameters

  • Optional options: AbortOptions

  Returns Promise<void>

unmap

• unmap(internalPort, options?): Promise<void>

• Unmap a previously mapped port. If the port was not mapped this is a no-op.

  Parameters

  • internalPort: number
  • Optional options: AbortOptions

  Returns Promise<void>