@scalar/api-client
Version:
the open source API testing client
48 lines • 2.25 kB
TypeScript
import type { HttpMethod as HttpMethodType } from '@scalar/helpers/http/http-methods';
import type { ServerMeta, 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 './AddressBarHistory.vue.js';
/**
* AddressBar component
* This component is used to display the address bar for the operation block
* It is used to display the path, method, server, and history for the operation
*/
declare const _default: typeof __VLS_export;
export default _default;
export type AddressBarProps = {
/** Current request path */
path: string;
/** Current request method */
method: HttpMethodType;
/** Currently selected server */
server: ServerObject | null;
/** Server list available for operation/document */
servers: ServerObject[];
/** List of request history */
history: History[];
/** Client layout */
layout: ClientLayout;
/** Event bus */
eventBus: WorkspaceEventBus;
/** Environment */
environment: XScalarEnvironment;
/** Meta information for the server */
serverMeta: ServerMeta;
};
declare const __VLS_export: import("vue").DefineComponent<AddressBarProps, {
methodConflict: import("vue").Ref<"delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace" | null, "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace" | null>;
pathConflict: import("vue").Ref<string | null, string | null>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
execute: () => any;
"select:history:item": (payload: {
index: number;
}) => any;
}, string, import("vue").PublicProps, Readonly<AddressBarProps> & Readonly<{
onExecute?: (() => any) | undefined;
"onSelect:history:item"?: ((payload: {
index: number;
}) => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
//# sourceMappingURL=AddressBar.vue.d.ts.map