@scalar/types/dist/api-reference/html-api.d.ts

Types to work with Scalar packages

import type { AnyApiReferenceConfiguration } from './api-reference-configuration.js';
/**
 * This is a subset of the vue app type
 * Didn't want to add vue as a dependency just for this type so we stub whatever we need for the html api
 */
type App<HostElement = any> = {
    mount(rootContainer: HostElement | string): unknown;
    unmount(): void;
    onUnmount(cb: () => void): void;
};
/** Enhanced ApiReferenceInstance with subset vue app */
export type ApiReferenceInstance = {
    /** The vue app instance */
    app: App<Element>;
    /** Destroy the current API Reference instance */
    destroy: () => void;
    /** Get the current configuration[s] */
    getConfiguration: () => AnyApiReferenceConfiguration;
    /** Update all configuration[s] */
    updateConfiguration: (newConfig: AnyApiReferenceConfiguration) => void;
};
/** Function overload for createApiReference to allow multiple different signatures */
export type CreateApiReference = {
    /** Pass in the configuration only */
    (configuration: AnyApiReferenceConfiguration): ApiReferenceInstance;
    /** Pass in the element or selector and configuration */
    (elementOrSelector: Element | string, configuration: AnyApiReferenceConfiguration): ApiReferenceInstance;
};
export {};
//# sourceMappingURL=html-api.d.ts.map