@scalar/api-reference/dist/features/multiple-documents/useMultipleDocuments.d.ts

Generate beautiful API references from OpenAPI documents

import { type AnyApiReferenceConfiguration, type ApiReferenceConfiguration, type SpecConfiguration, apiReferenceConfigurationSchema } from '@scalar/types/api-reference';
import { type ComputedRef, type Ref } from 'vue';
import type { z } from 'zod';
type UseMultipleDocumentsProps = {
    /**
     * Configuration for the API reference.
     * Can be a single configuration or an array of configurations for multiple documents.
     */
    configuration: Ref<AnyApiReferenceConfiguration | undefined>;
    /** Configuration options to apply over the currently selected configuration */
    configurationOverrides?: Ref<Partial<ApiReferenceConfiguration> | undefined>;
    /** The initial index to pre-select a document, if there is no query parameter available */
    initialIndex?: number;
    isIntersectionEnabled: Ref<boolean>;
    hash: Ref<string>;
    hashPrefix: Ref<string>;
};
/**
 * Take any configuration and return a flat array of configurations.
 */
export declare const normalizeConfigurations: (configuration: AnyApiReferenceConfiguration | undefined) => SpecConfiguration[];
/**
 * DEPRECATED: This is a temporary state solution while we migrate to the new workspace store
 *
 * @deprecated
 */
export declare const useMultipleDocuments: ({ configuration, configurationOverrides, initialIndex, isIntersectionEnabled, hash, hashPrefix, }: UseMultipleDocumentsProps) => {
    selectedConfiguration: ComputedRef<z.infer<typeof apiReferenceConfigurationSchema>>;
    availableDocuments: Ref<SpecConfiguration[]>;
    selectedDocumentIndex: Ref<number>;
    isIntersectionEnabled: Ref<boolean>;
    hash: Ref<string>;
    hashPrefix: Ref<string>;
};
export {};
//# sourceMappingURL=useMultipleDocuments.d.ts.map