@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;
    operationTitleSource: "path" | "summary";
    theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
    persistAuth: boolean;
    telemetry: boolean;
    title?: string | undefined | undefined;
    url?: string | undefined | undefined;
    content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
    slug?: string | undefined | undefined;
    spec?: {
        title?: string | undefined | undefined;
        url?: string | undefined | undefined;
        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
        slug?: string | undefined | undefined;
    } | undefined;
    authentication?: any;
    baseServerURL?: string | undefined | undefined;
    proxyUrl?: string | undefined | undefined;
    searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined | undefined;
    servers?: any[] | undefined | undefined;
    _integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined | undefined;
    onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined | undefined;
    plugins?: ((...args: unknown[]) => {
        name: string;
        views?: {
            "request.section"?: {
                title?: string | undefined;
                component?: unknown;
                props?: Record<string, any> | undefined;
            }[] | undefined;
            "response.section"?: {
                title?: string | undefined;
                component?: unknown;
                props?: Record<string, any> | undefined;
            }[] | undefined;
        } | undefined;
        hooks?: {
            onBeforeRequest?: ((args_0: {
                request: Request;
            }, ...args: unknown[]) => void | Promise<void>) | undefined;
            onResponseReceived?: ((args_0: {
                response: Response;
                operation: Record<string, any>;
            }, ...args: unknown[]) => void | Promise<void>) | undefined;
        } | undefined;
    })[] | undefined | undefined;
}, {
    hideClientButton: boolean;
    showSidebar: boolean;
    operationTitleSource: "path" | "summary";
    theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
    persistAuth: boolean;
    telemetry: boolean;
    title?: string | undefined;
    url?: string | undefined;
    content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
    slug?: string | undefined;
    spec?: {
        title?: string | undefined;
        url?: string | undefined;
        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
        slug?: string | undefined;
    } | undefined;
    authentication?: any;
    baseServerURL?: string | undefined;
    proxyUrl?: string | undefined;
    searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
    servers?: any[] | undefined;
    _integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
    onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
    plugins?: ((...args: unknown[]) => {
        name: string;
        views?: {
            "request.section"?: {
                title?: string | undefined;
                component?: unknown;
                props?: Record<string, any> | undefined;
            }[] | undefined;
            "response.section"?: {
                title?: string | undefined;
                component?: unknown;
                props?: Record<string, any> | undefined;
            }[] | undefined;
        } | undefined;
        hooks?: {
            onBeforeRequest?: ((args_0: {
                request: Request;
            }, ...args: unknown[]) => void | Promise<void>) | undefined;
            onResponseReceived?: ((args_0: {
                response: Response;
                operation: Record<string, any>;
            }, ...args: unknown[]) => void | Promise<void>) | undefined;
        } | undefined;
    })[] | undefined;
} | {
    hideClientButton: boolean;
    showSidebar: boolean;
    operationTitleSource: "path" | "summary";
    theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
    persistAuth: boolean;
    telemetry: boolean;
    title?: string | undefined | undefined;
    url?: string | undefined | undefined;
    content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
    slug?: string | undefined | undefined;
    spec?: {
        title?: string | undefined | undefined;
        url?: string | undefined | undefined;
        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
        slug?: string | undefined | undefined;
    } | undefined;
    authentication?: any;
    baseServerURL?: string | undefined | undefined;
    proxyUrl?: string | undefined | undefined;
    searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined | undefined;
    servers?: any[] | undefined | undefined;
    _integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined | undefined;
    onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined | undefined;
    plugins?: ((...args: unknown[]) => {
        name: string;
        views?: {
            "request.section"?: {
                title?: string | undefined;
                component?: unknown;
                props?: Record<string, any> | undefined;
            }[] | undefined;
            "response.section"?: {
                title?: string | undefined;
                component?: unknown;
                props?: Record<string, any> | undefined;
            }[] | undefined;
        } | undefined;
        hooks?: {
            onBeforeRequest?: ((args_0: {
                request: Request;
            }, ...args: unknown[]) => void | Promise<void>) | undefined;
            onResponseReceived?: ((args_0: {
                response: Response;
                operation: Record<string, any>;
            }, ...args: unknown[]) => void | Promise<void>) | undefined;
        } | undefined;
    })[] | undefined | undefined;
}>;
//# sourceMappingURL=useClientConfig.d.ts.map