@scalar/api-client
Version:
the open source API testing client
35 lines • 1.74 kB
TypeScript
import type { CommandPaletteEvent } from '../components/CommandPalette/TheCommandPalette.vue.js';
import type { RequestStatus } from '../libs/send-request/index.js';
/** Create the store for the api client events */
export declare function createStoreEvents(): {
/**
* Event bus to execute requests, usually triggered by the send button in the address bar
* OR the keyboard shortcut
*/
executeRequest: import("../libs/event-bus.js").EventBus<{
requestUid?: string;
}>;
/**
* Event bus to focus the address bar or send button
*/
focusAddressBar: import("../libs/event-bus.js").EventBus<any>;
/**
* Event bus to cancel requests, usually triggered by response loading overlay
*/
cancelRequest: import("../libs/event-bus.js").EventBus<any>;
/**
* Event bus to keep track of when a request is started, stopped, or aborted
*/
requestStatus: import("../libs/event-bus.js").EventBus<RequestStatus>;
/**
* Event bus for controlling the Command Palette
*
* @param commandName - the command name you wish to execute, leave empty for the full palette
*/
commandPalette: import("../libs/event-bus.js").EventBus<CommandPaletteEvent>;
/**
* Event bus for handling hot keys
*/
hotKeys: import("../libs/event-bus.js").EventBus<Partial<Record<"addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar", KeyboardEvent>>>;
};
//# sourceMappingURL=events.d.ts.map