HttpApiScalar
Layers
Signature
declare function layer(options?: { readonly path?: `/${string}`; readonly scalar?: ScalarConfig;}): Layer<never, never, Api>Signature
declare function layerCdn(options?: { readonly path?: `/${string}`; readonly scalar?: ScalarConfig; readonly version?: string;}): Layer<never, never, Api>layerHttpLayerRouter
Added in v1.0.0
Source
Signature
declare const layerHttpLayerRouter: (options: { readonly api: HttpApi.HttpApi.Any; readonly path: `/${string}`; readonly scalar?: ScalarConfig;}) => Layer.Layer<never, never, HttpLayerRouter.HttpRouter>layerHttpLayerRouterCdn
Added in v1.0.0
Source
Signature
declare const layerHttpLayerRouterCdn: (options: { readonly api: HttpApi.HttpApi.Any; readonly path: `/${string}`; readonly scalar?: ScalarConfig; readonly version?: string;}) => Layer.Layer<never, never, HttpLayerRouter.HttpRouter>Model
ScalarConfig type
Added in v1.0.0
Source
Signature
type ScalarConfig = { baseServerURL?: string; customCss?: string; darkMode?: boolean; defaultOpenAllTags?: boolean; favicon?: string; forceDarkModeState?: "dark" | "light"; hideDarkModeToggle?: boolean; hideModels?: boolean; hideSearch?: boolean; hideTestRequestButton?: boolean; layout?: "modern" | "classic"; proxyUrl?: string; showSidebar?: boolean; theme?: ScalarThemeId; withDefaultFonts?: boolean;}ScalarThemeId type
Added in v1.0.0
Source
Signature
type ScalarThemeId = "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "saturn" | "kepler" | "mars" | "deepSpace" | "laserwave" | "none"