Packages@robojs/server
TunnelProvider
Interface: TunnelProvider
Interface for tunnel providers. Implement this to add support for new tunnel services.
Properties
Methods
initialize()?
optional initialize(config): Promise<boolean>Initialize tunnel configuration (optional, for static tunnels)
Parameters
| Parameter | Type |
|---|---|
config | TunnelProviderConfig |
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
| Parameter | Type |
|---|---|
url | string |
config? | TunnelProviderConfig |
Returns
Promise<TunnelInstance>
stop()
stop(instance, signal?): Promise<void>Stop a running tunnel instance
Parameters
| Parameter | Type |
|---|---|
instance | TunnelInstance |
signal? | Signals |
Returns
Promise<void>
