@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
15 lines • 819 B
TypeScript
import type { OpenApiDocument } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
import type { FuseResult } from 'fuse.js';
import type { useSidebar } from '../../../v2/blocks/scalar-sidebar-block';
import type { FuseData } from '../types';
/**
* Creates the search index from an OpenAPI document.
*/
export declare function useSearchIndex(items: ReturnType<typeof useSidebar>['items'], document?: OpenApiDocument): {
resetSearch: () => void;
selectedIndex: import("vue").Ref<number | undefined, number | undefined>;
selectedSearchResult: import("vue").ComputedRef<FuseResult<FuseData> | undefined>;
searchResultsWithPlaceholderResults: import("vue").ComputedRef<FuseResult<FuseData>[]>;
query: import("vue").Ref<string, string>;
};
//# sourceMappingURL=useSearchIndex.d.ts.map