serverstruct/dist/openapi.scalar.d.cts

Type safe and modular servers with H3

import * as h32 from "h3";
import { AnyApiReferenceConfiguration, AnyApiReferenceConfiguration as AnyApiReferenceConfiguration$1, renderApiReference } from "@scalar/client-side-rendering";

//#region src/openapi.scalar.d.ts

/**
 * Renders a Scalar API reference UI as an HTML string.
 *
 * @experimental This API is experimental and may change in future versions.
 *
 * @param options.config - Scalar API reference configuration.
 * @param options.pageTitle - Page title. Defaults to "Scalar API Reference".
 * @param options.cdn - CDN URL for the standalone bundle. Defaults to jsDelivr.
 * @param customTheme - Custom CSS theme for the Scalar UI.
 */
declare function apiReference(options: {
  /** The API reference configuration. */
  config: AnyApiReferenceConfiguration$1;
  /** Page title. Defaults to "Scalar API Reference". */
  pageTitle?: string;
  /** CDN URL for the standalone bundle. Defaults to jsDelivr. */
  cdn?: string;
}, customTheme?: string): h32.HTTPResponse;
//#endregion
export { type AnyApiReferenceConfiguration, apiReference, renderApiReference };