ScalarPluginOptions
ScalarPluginOptions =
object
Defined in: src/plugins/application/scalar.ts:12
Properties
Section titled “Properties”baseDocument?
Section titled “baseDocument?”
optionalbaseDocument:DeepPartial<OpenAPI.Document>
Defined in: src/plugins/application/scalar.ts:16
Base document to use for API reference.
config?
Section titled “config?”
optionalconfig:Partial<ApiReferenceConfiguration>
Defined in: src/plugins/application/scalar.ts:20
Configuration for API reference.
enableStaticAnalysis?
Section titled “enableStaticAnalysis?”
optionalenableStaticAnalysis:boolean
Defined in: src/plugins/application/scalar.ts:29
Whether to enable static analysis. When this is enabled, the plugin will run static analysis on the entrypoint and generate an OpenAPI document. This is useful for when you want to generate an OpenAPI document without having to manually define it.
Only works with TypeScript entrypoints.