config-rocket
    Preparing search index...

    Interface ParseRocketConfigHooks

    interface ParseRocketConfigHooks {
        onExcludeResolver: (
            props: {
                excludeResolver: [
                    excludeName: string,
                    resolverValue: boolean
                    | RocketResolvable<true>,
                ];
                resolvedExcludes: Record<string, boolean>;
            },
        ) => void
        | Promise<void>;
        onFileBuildResolver: (
            props: {
                fileBuildResolver: [
                    builderKey: string,
                    builderConfig: {
                        content: string
                        | RocketResolvable<string>;
                        filePath: string;
                    },
                ];
                resolvedFilesBuilder: Record<
                    string,
                    { content: string; filePath: string },
                >;
            },
        ) => void
        | Promise<void>;
        onParameter: (
            props: {
                parameter: RocketConfigParameter;
                resolvedParameters: Record<string, string | boolean>;
            },
        ) => void
        | Promise<void>;
        onVariableResolver: (
            props: {
                resolvedVariables: Record<string, string>;
                variableResolver: [
                    variableName: string,
                    resolverValue: string
                    | RocketResolvable<string>,
                ];
            },
        ) => void
        | Promise<void>;
        [key: string]: HookCallback;
    }

    Hierarchy

    • Hooks
      • ParseRocketConfigHooks

    Indexable

    • [key: string]: HookCallback
    Index

    Properties

    onExcludeResolver onFileBuildResolver onParameter onVariableResolver

    Properties

    onExcludeResolver: (
        props: {
            excludeResolver: [
                excludeName: string,
                resolverValue: boolean
                | RocketResolvable<true>,
            ];
            resolvedExcludes: Record<string, boolean>;
        },
    ) => void
    | Promise<void>

    excludeResolver and resolvedExcludes are mutable, the resolver fn will not be called for excludes that already has a resolved value.

    onFileBuildResolver: (
        props: {
            fileBuildResolver: [
                builderKey: string,
                builderConfig: {
                    content: string
                    | RocketResolvable<string>;
                    filePath: string;
                },
            ];
            resolvedFilesBuilder: Record<
                string,
                { content: string; filePath: string },
            >;
        },
    ) => void
    | Promise<void>

    fileBuildResolver and resolvedFilesBuilder are mutable, the resolver fn will not be called for files that already has a resolved value.

    onParameter: (
        props: {
            parameter: RocketConfigParameter;
            resolvedParameters: Record<string, string | boolean>;
        },
    ) => void
    | Promise<void>

    parameter and resolvedParameters are mutable, the resolver fn will not be called for parameters that already has a resolved value.

    onVariableResolver: (
        props: {
            resolvedVariables: Record<string, string>;
            variableResolver: [
                variableName: string,
                resolverValue: string
                | RocketResolvable<string>,
            ];
        },
    ) => void
    | Promise<void>

    variableResolver and resolvedVariables are mutable, the resolver fn will not be called for variables that already has a resolved value.

    Settings

    Member Visibility

    On This Page

    Properties