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 Summary)

Properties

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