@scalar/api-client
Version:
the open source API testing client
47 lines • 1.97 kB
TypeScript
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
/**
* Command Palette Request Component
*
* Provides a form for creating a new API request (operation) in a document.
* Users can specify the request path, HTTP method, document (collection),
* and optionally assign it to a tag.
*
* Validates that no operation with the same path and method already exists
* in the selected document to prevent duplicates.
*
* @example
* <CommandPaletteRequest
* :workspaceStore="workspaceStore"
* :eventBus="eventBus"
* @close="handleClose"
* @back="handleBack"
* />
*/
declare const _default: import("vue").DefineComponent<{
/** The workspace store for accessing documents and operations */
workspaceStore: WorkspaceStore;
/** Event bus for emitting operation creation events */
eventBus: WorkspaceEventBus;
/** Preselected document id to create the request in */
documentId?: string;
/** Preselected tag id to add the request to (optional) */
tagId?: string;
}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
close: () => any;
back: (keyboardEvent: KeyboardEvent) => any;
}, string, import("vue").PublicProps, Readonly<{
/** The workspace store for accessing documents and operations */
workspaceStore: WorkspaceStore;
/** Event bus for emitting operation creation events */
eventBus: WorkspaceEventBus;
/** Preselected document id to create the request in */
documentId?: string;
/** Preselected tag id to add the request to (optional) */
tagId?: string;
}> & Readonly<{
onClose?: (() => any) | undefined;
onBack?: ((keyboardEvent: KeyboardEvent) => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default;
//# sourceMappingURL=CommandPaletteRequest.vue.d.ts.map