@gud/cli
    Preparing search index...

    Interface ContextParams<TOptions>

    Params for creating a new Context instance.

    interface ContextParams<TOptions extends OptionsConfig = OptionsConfig> {
        client?: Client;
        commandsDir: string;
        commandString: string;
        hooks?: HookRegistry<LifecycleHooks>;
        options?: TOptions;
        parseFn?: ParseCommandFn;
        plugins?: Plugin[];
        resolveFn?: ResolveCommandFn;
    }

    Type Parameters

    Index

    Properties

    client? commandsDir commandString hooks? options? parseFn? plugins? resolveFn?

    Properties

    client?: Client

    The client instance to use for logging and user interaction.

    new Client()
    commandsDir: string
    commandString: string
    hooks?: HookRegistry<LifecycleHooks>

    The hooks emitter

    options?: TOptions

    The options config for the command

    parseFn?: ParseCommandFn
    plugins?: Plugin[]

    A list of plugins to load

    resolveFn?: ResolveCommandFn

    Settings

    Member Visibility

    On This Page

    Properties