LogoRobo.js
Packages@robojs/server

TunnelProvider

Interface: TunnelProvider

Interface for tunnel providers. Implement this to add support for new tunnel services.

Properties

PropertyTypeDescription
namestringProvider name (e.g., 'cloudflare', 'ngrok')

Methods

initialize()?

optional initialize(config): Promise<boolean>

Initialize tunnel configuration (optional, for static tunnels)

Parameters

ParameterType
configTunnelProviderConfig

Returns

Promise<boolean>


install()

install(): Promise<void>

Install the tunnel binary

Returns

Promise<void>


isInstalled()

isInstalled(): boolean | Promise<boolean>

Check if the tunnel binary is installed

Returns

boolean | Promise<boolean>


start()

start(url, config?): Promise<TunnelInstance>

Start the tunnel and return the instance

Parameters

ParameterType
urlstring
config?TunnelProviderConfig

Returns

Promise<TunnelInstance>


stop()

stop(instance, signal?): Promise<void>

Stop a running tunnel instance

Parameters

ParameterType
instanceTunnelInstance
signal?Signals

Returns

Promise<void>

On this page