@scalar/api-client/dist/hooks/useClientConfig.d.ts

the open source API testing client

import { type ApiClientConfiguration } from '@scalar/types/api-reference';
import { type InjectionKey, type Ref } from 'vue';
export declare const CLIENT_CONFIGURATION_SYMBOL: InjectionKey<Ref<ApiClientConfiguration>>;
/** Hook for easy access to the reference configuration */
export declare const useClientConfig: () => Ref<{
    hideClientButton: boolean;
    showSidebar: boolean;
    showToolbar: "never" | "always" | "localhost";
    operationTitleSource: "summary" | "path";
    theme: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
    persistAuth: boolean;
    telemetry: boolean;
    authentication?: any;
    baseServerURL?: string | undefined;
    proxyUrl?: string | undefined;
    searchHotKey?: "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
    servers?: any[] | undefined;
    _integration?: "elysiajs" | "fastify" | "adonisjs" | "astro" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
    onRequestSent?: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodString], null>, import("zod").ZodVoid> | undefined;
    plugins?: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodObject<{
        name: import("zod").ZodString;
        views: import("zod").ZodOptional<import("zod").ZodObject<{
            "request.section": import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                title: import("zod").ZodOptional<import("zod").ZodString>;
                component: import("zod").ZodUnknown;
                props: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
            }, import("zod/v4/core").$strip>>>;
            "response.section": import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                title: import("zod").ZodOptional<import("zod").ZodString>;
                component: import("zod").ZodUnknown;
                props: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
            }, import("zod/v4/core").$strip>>>;
        }, import("zod/v4/core").$strip>>;
        hooks: import("zod").ZodOptional<import("zod").ZodObject<{
            onBeforeRequest: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
                request: import("zod").ZodCustom<Request, Request>;
            }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
            onResponseReceived: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
                response: import("zod").ZodCustom<Response, Response>;
                operation: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>;
            }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
        }, import("zod/v4/core").$strip>>;
    }, import("zod/v4/core").$strip>>[] | undefined;
    default?: boolean | undefined;
    url?: string | undefined;
    content?: string | Record<string, any> | import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>> | null | undefined;
    title?: string | undefined;
    slug?: string | undefined;
    spec?: {
        url?: string | undefined;
        content?: string | Record<string, any> | import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>> | null | undefined;
    } | undefined;
}, {
    hideClientButton: boolean;
    showSidebar: boolean;
    showToolbar: "never" | "always" | "localhost";
    operationTitleSource: "summary" | "path";
    theme: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
    persistAuth: boolean;
    telemetry: boolean;
    authentication?: any;
    baseServerURL?: string | undefined;
    proxyUrl?: string | undefined;
    searchHotKey?: "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
    servers?: any[] | undefined;
    _integration?: "elysiajs" | "fastify" | "adonisjs" | "astro" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
    onRequestSent?: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodString], null>, import("zod").ZodVoid> | undefined;
    plugins?: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodObject<{
        name: import("zod").ZodString;
        views: import("zod").ZodOptional<import("zod").ZodObject<{
            "request.section": import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                title: import("zod").ZodOptional<import("zod").ZodString>;
                component: import("zod").ZodUnknown;
                props: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
            }, import("zod/v4/core").$strip>>>;
            "response.section": import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                title: import("zod").ZodOptional<import("zod").ZodString>;
                component: import("zod").ZodUnknown;
                props: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
            }, import("zod/v4/core").$strip>>>;
        }, import("zod/v4/core").$strip>>;
        hooks: import("zod").ZodOptional<import("zod").ZodObject<{
            onBeforeRequest: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
                request: import("zod").ZodCustom<Request, Request>;
            }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
            onResponseReceived: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
                response: import("zod").ZodCustom<Response, Response>;
                operation: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>;
            }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
        }, import("zod/v4/core").$strip>>;
    }, import("zod/v4/core").$strip>>[] | undefined;
    default?: boolean | undefined;
    url?: string | undefined;
    content?: string | Record<string, any> | import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>> | null | undefined;
    title?: string | undefined;
    slug?: string | undefined;
    spec?: {
        url?: string | undefined;
        content?: string | Record<string, any> | import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>> | null | undefined;
    } | undefined;
} | {
    hideClientButton: boolean;
    showSidebar: boolean;
    showToolbar: "never" | "always" | "localhost";
    operationTitleSource: "summary" | "path";
    theme: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
    persistAuth: boolean;
    telemetry: boolean;
    authentication?: any;
    baseServerURL?: string | undefined;
    proxyUrl?: string | undefined;
    searchHotKey?: "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
    servers?: any[] | undefined;
    _integration?: "elysiajs" | "fastify" | "adonisjs" | "astro" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
    onRequestSent?: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodString], null>, import("zod").ZodVoid> | undefined;
    plugins?: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodObject<{
        name: import("zod").ZodString;
        views: import("zod").ZodOptional<import("zod").ZodObject<{
            "request.section": import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                title: import("zod").ZodOptional<import("zod").ZodString>;
                component: import("zod").ZodUnknown;
                props: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
            }, import("zod/v4/core").$strip>>>;
            "response.section": import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                title: import("zod").ZodOptional<import("zod").ZodString>;
                component: import("zod").ZodUnknown;
                props: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
            }, import("zod/v4/core").$strip>>>;
        }, import("zod/v4/core").$strip>>;
        hooks: import("zod").ZodOptional<import("zod").ZodObject<{
            onBeforeRequest: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
                request: import("zod").ZodCustom<Request, Request>;
            }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
            onResponseReceived: import("zod").ZodOptional<import("zod").ZodFunction<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
                response: import("zod").ZodCustom<Response, Response>;
                operation: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>;
            }, import("zod/v4/core").$strip>], null>, import("zod/v4/core").$ZodFunctionOut>>;
        }, import("zod/v4/core").$strip>>;
    }, import("zod/v4/core").$strip>>[] | undefined;
    default?: boolean | undefined;
    url?: string | undefined;
    content?: string | Record<string, any> | import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>> | null | undefined;
    title?: string | undefined;
    slug?: string | undefined;
    spec?: {
        url?: string | undefined;
        content?: string | Record<string, any> | import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [], null>, import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>> | null | undefined;
    } | undefined;
}>;
//# sourceMappingURL=useClientConfig.d.ts.map