@gibme/webserver
    Preparing search index...

    Type Alias Tunnel

    type Tunnel = {
        binary?: string;
        connections: Connection[];
        install: () => Promise<string | undefined>;
        start: (timeout?: number) => Promise<boolean>;
        stop: () => Promise<void>;
        url?: string;
    }
    Index

    Properties

    binary? connections install start stop url?

    Properties

    binary?: string

    The path to the cloudflared binary

    connections: Connection[]

    The connections of the cloudflared tunnel

    install: () => Promise<string | undefined>

    Installs the cloudflared binary if it is not already installed and returns the path to the binary

    start: (timeout?: number) => Promise<boolean>

    Starts a cloudflared tunnel

    Type declaration

      • (timeout?: number): Promise<boolean>

      • Parameters

        • Optionaltimeout: number

          The timeout in milliseconds to wait for the tunnel to start. Defaults to 30000.

        Returns Promise<boolean>

    stop: () => Promise<void>

    Stops the cloudflared tunnel

    url?: string

    The public URL of the cloudflared tunnel

    Settings

    Member Visibility

    On This Page

    Properties