@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
60 lines • 3.21 kB
TypeScript
import type { OpenAPIV3_1 } from '@scalar/openapi-types';
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
import type { WorkspaceDocument } from '@scalar/workspace-store/schemas/workspace';
/**
* A collection of tools which are used strictly for testing
*/
export declare const createMockSidebar: (collapsedItems?: Record<string, boolean>, entries?: TraversedEntry[]) => {
collapsedSidebarItems: Record<string, boolean>;
isSidebarOpen: import("vue").Ref<boolean, boolean>;
items: import("vue").ComputedRef<{
entries: TraversedEntry[];
entities: Map<any, any>;
}>;
scrollToOperation: import("vitest").Mock<(...args: any[]) => any>;
setCollapsedSidebarItem: import("vitest").Mock<(...args: any[]) => any>;
toggleCollapsedSidebarItem: import("vitest").Mock<(...args: any[]) => any>;
};
export declare const createMockSidebarFromDocument: (document: OpenAPIV3_1.Document) => {
collapsedSidebarItems: Record<string, boolean>;
isSidebarOpen: import("vue").Ref<boolean, boolean>;
items: import("vue").ComputedRef<{
entries: TraversedEntry[];
entities: Map<any, any>;
}>;
scrollToOperation: import("vitest").Mock<(...args: any[]) => any>;
setCollapsedSidebarItem: import("vitest").Mock<(...args: any[]) => any>;
toggleCollapsedSidebarItem: import("vitest").Mock<(...args: any[]) => any>;
};
export declare const createMockPluginManager: () => {
getSpecificationExtensions: import("vitest").Mock<(...args: any[]) => any>;
};
export declare const createMockNavState: (hash?: string) => {
hash: import("vue").Ref<string, string>;
hashPrefix: import("vue").Ref<string, string>;
isIntersectionEnabled: import("vue").Ref<boolean, boolean>;
setHashPrefix: import("vitest").Mock<(...args: any[]) => any>;
getFullHash: import("vitest").Mock<(...args: any[]) => any>;
getHashedUrl: import("vitest").Mock<(...args: any[]) => any>;
replaceUrlState: import("vitest").Mock<(...args: any[]) => any>;
getReferenceId: import("vitest").Mock<(...args: any[]) => any>;
getWebhookId: import("vitest").Mock<(...args: any[]) => any>;
getModelId: import("vitest").Mock<(...args: any[]) => any>;
getHeadingId: import("vitest").Mock<(...args: any[]) => any>;
getOperationId: import("vitest").Mock<(...args: any[]) => any>;
getPathRoutingId: import("vitest").Mock<(...args: any[]) => any>;
getSectionId: import("vitest").Mock<(...args: any[]) => any>;
getTagId: import("vitest").Mock<(...args: any[]) => any>;
updateHash: import("vitest").Mock<(...args: any[]) => any>;
};
export declare const createMockStore: (activeDocument: WorkspaceDocument) => WorkspaceStore;
export declare const createMockLocalStorage: () => {
getItem: import("vitest").Mock<(...args: any[]) => any>;
setItem: import("vitest").Mock<(...args: any[]) => any>;
removeItem: import("vitest").Mock<(...args: any[]) => any>;
clear: import("vitest").Mock<(...args: any[]) => any>;
key: import("vitest").Mock<(...args: any[]) => any>;
length: number;
};
//# sourceMappingURL=test-utils.d.ts.map