@scalar/api-client
Version:
the open source API testing client
54 lines • 2.31 kB
TypeScript
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/openapi-document';
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;
/** 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[];
/** Event bus */
eventBus: WorkspaceEventBus;
/** Environment list */
environments?: string[];
/** Currently selected environment */
activeEnvironment?: string;
/** Environment variables */
environment: XScalarEnvironment;
};
declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
execute: () => any;
"update:servers": () => any;
"select:history:item": (payload: {
index: number;
}) => any;
"add:environment": () => any;
}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
onExecute?: (() => any) | undefined;
"onUpdate:servers"?: (() => any) | undefined;
"onSelect:history:item"?: ((payload: {
index: number;
}) => any) | undefined;
"onAdd:environment"?: (() => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
declare const _default: typeof __VLS_export;
export default _default;
//# sourceMappingURL=Header.vue.d.ts.map