Interface HookReturnPerTunnelPlugin

Tunnel Plugins types

Any plugin that provides tunnel functionality should implement defineProviderand startTunnel

interface HookReturnPerTunnelPlugin {
    tunnel_provider: {
        options: {
            [key: string]: never;
        };
        pluginReturns: {
            [pluginName: string]: {
                name: string;
            };
        };
    };
    tunnel_start: {
        options: {
            port: number;
            provider: string;
        };
        pluginReturns: {
            [key: string]: Result<TunnelClient, TunnelError>;
        };
    };
}

Hierarchy (view full)

Properties

tunnel_provider tunnel_start

Properties

tunnel_provider

tunnel_provider: {
    options: {
        [key: string]: never;
    };
    pluginReturns: {
        [pluginName: string]: {
            name: string;
        };
    };
}

Type declaration

  • options: {
        [key: string]: never;
    }
    • [key: string]: never
  • pluginReturns: {
        [pluginName: string]: {
            name: string;
        };
    }
    • [pluginName: string]: {
          name: string;
      }
      • name: string

tunnel_start

tunnel_start: {
    options: {
        port: number;
        provider: string;
    };
    pluginReturns: {
        [key: string]: Result<TunnelClient, TunnelError>;
    };
}

Type declaration

Settings

Member Visibility

Theme

On This Page

tunnel_providertunnel_start