LogoRobo.js
Packages@robojs/server

CloudflareProvider

Class: CloudflareProvider

Cloudflare Tunnel Provider implementation.

Implements

Constructors

new CloudflareProvider()

new CloudflareProvider(): CloudflareProvider

Returns

CloudflareProvider

Properties

PropertyTypeDefault valueDescription
namestring'cloudflare'Provider name (e.g., 'cloudflare', 'ngrok')

Methods

initialize()

initialize(config): Promise<boolean>

Initialize tunnel configuration (optional, for static tunnels)

Parameters

ParameterType
configTunnelProviderConfig

Returns

Promise<boolean>

Implementation of

TunnelProvider.initialize


install()

install(): Promise<void>

Install the tunnel binary

Returns

Promise<void>

Implementation of

TunnelProvider.install


isInstalled()

isInstalled(): boolean

Check if the tunnel binary is installed

Returns

boolean

Implementation of

TunnelProvider.isInstalled


start()

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

Start the tunnel and return the instance

Parameters

ParameterType
urlstring
config?TunnelProviderConfig

Returns

Promise<TunnelInstance>

Implementation of

TunnelProvider.start


stop()

stop(instance, signal): Promise<void>

Stop a running tunnel instance

Parameters

ParameterTypeDefault value
instanceTunnelInstanceundefined
signalSignals'SIGINT'

Returns

Promise<void>

Implementation of

TunnelProvider.stop

On this page