@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
43 lines • 2.11 kB
TypeScript
import type { ApiReferenceConfiguration } from '@scalar/types';
import type { ExternalDocumentationObject, InfoObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
type __VLS_Props = {
/** Optional unique identifier for the info block. */
id?: string;
/** Original openapi version of the input document */
oasVersion?: string;
/** The Info object from the OpenAPI document. */
info: InfoObject;
/** The external documentation object from the OpenAPI document, if present. */
externalDocs?: ExternalDocumentationObject;
/** OpenAPI extension fields at the document level. */
documentExtensions?: Record<string, unknown>;
/** OpenAPI extension fields at the info object level. */
infoExtensions?: Record<string, unknown>;
options: {
/** Indicates if the info block is in a loading state. */
isLoading?: boolean;
/** Determines the layout style for the info block ('modern' or 'classic'). */
layout?: 'modern' | 'classic';
/** The document download type. */
documentDownloadType?: ApiReferenceConfiguration['documentDownloadType'];
/** The URL of the OpenAPI document. */
url?: string | undefined;
/** Optional callback invoked when the component has finished loading. */
onLoaded?: (() => void) | unknown;
/** The original document content. */
getOriginalDocument: () => string;
};
};
declare var __VLS_8: {};
type __VLS_Slots = {} & {
selectors?: (props: typeof __VLS_8) => any;
};
declare const __VLS_component: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
export default _default;
type __VLS_WithSlots<T, S> = T & {
new (): {
$slots: S;
};
};
//# sourceMappingURL=InfoBlock.vue.d.ts.map