UNPKG

@scalar/api-client

Version:

the open source API testing client

63 lines 2.51 kB
import type { HttpMethod } from '@scalar/helpers/http/http-methods'; import type { WorkspaceEventBus } from '@scalar/workspace-store/events'; import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments'; import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/server'; import type { ClientLayout } from '../../../../hooks/index.js'; import { type History } from '../../../../v2/blocks/scalar-address-bar-block/index.js'; type __VLS_Props = { /** Current request path */ path: string; /** Current request method */ method: HttpMethod; /** Client layout */ layout: ClientLayout; /** Sidebar open state */ isSidebarOpen?: boolean; /** Controls sidebar visibility */ showSidebar?: boolean; /** Hides the client button on the header */ hideClientButton?: boolean; /** Client integration */ integration?: string | null; /** Openapi document url for `modal` mode to open the client app */ documentUrl?: string; /** Client source */ source?: 'gitbook' | 'api-reference'; /** Currently selected server */ server: ServerObject | null; /** Server list available for operation/document */ servers: ServerObject[]; /** List of request history */ history: History[]; /** * When the request is sent from the modal, this indicates the progress percentage * of the request being sent. * * The amount remaining to load from 100 -> 0 */ requestLoadingPercentage?: number; /** Event bus */ eventBus: WorkspaceEventBus; environment: XScalarEnvironment; }; declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & { execute: () => any; "update:servers": () => any; "update:path": (payload: { value: string; }) => any; "update:method": (payload: { value: HttpMethod; }) => any; }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{ onExecute?: (() => any) | undefined; "onUpdate:servers"?: (() => any) | undefined; "onUpdate:path"?: ((payload: { value: string; }) => any) | undefined; "onUpdate:method"?: ((payload: { value: HttpMethod; }) => any) | undefined; }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>; export default _default; //# sourceMappingURL=Header.vue.d.ts.map