@shopify/cli-kit
    Preparing search index...

    Interface HookReturnsPerPlugin

    Tunnel Plugins types

    Any plugin that provides tunnel functionality should implement defineProviderand startTunnel

    interface HookReturnsPerPlugin {
        public_command_metadata: {
            options: Record<string, never>;
            pluginReturns: {
                "@shopify/app": Partial<AppSpecificMonorailFields>;
                [pluginName: string]: JsonMap;
            };
        };
        sensitive_command_metadata: {
            options: Record<string, never>;
            pluginReturns: {
                "@shopify/app": Partial<AppSpecificSensitiveMonorailFields>;
                [pluginName: string]: JsonMap;
            };
        };
        tunnel_provider: {
            options: Record<string, never>;
            pluginReturns: Record<string, { name: string }>;
        };
        tunnel_start: {
            options: { port: number; provider: string };
            pluginReturns: Record<string, Result<TunnelClient, TunnelError>>;
        };
        [hookName: string]: {
            options: Record<string, unknown>;
            pluginReturns: Record<string, unknown>;
        };
    }

    Hierarchy (View Summary)

    Indexable

    • [hookName: string]: { options: Record<string, unknown>; pluginReturns: Record<string, unknown> }
    Index

    Properties

    public_command_metadata: {
        options: Record<string, never>;
        pluginReturns: {
            "@shopify/app": Partial<AppSpecificMonorailFields>;
            [pluginName: string]: JsonMap;
        };
    }
    sensitive_command_metadata: {
        options: Record<string, never>;
        pluginReturns: {
            "@shopify/app": Partial<AppSpecificSensitiveMonorailFields>;
            [pluginName: string]: JsonMap;
        };
    }
    tunnel_provider: {
        options: Record<string, never>;
        pluginReturns: Record<string, { name: string }>;
    }
    tunnel_start: {
        options: { port: number; provider: string };
        pluginReturns: Record<string, Result<TunnelClient, TunnelError>>;
    }