Skip to main content Link Search Menu Expand Document (external link)

Configuration overview

Added in v1.0.0


Table of contents


service

Configuration (class)

Signature

export declare class Configuration

Added in v1.0.0

ConfigurationSchema

Signature

export declare const ConfigurationSchema: Schema.Struct<{
  $schema: Schema.optional<typeof Schema.String>
  projectHomepage: Schema.optional<typeof Schema.String>
  srcDir: Schema.optional<typeof Schema.String>
  outDir: Schema.optional<typeof Schema.String>
  theme: Schema.optional<typeof Schema.String>
  enableSearch: Schema.optional<typeof Schema.Boolean>
  enforceDescriptions: Schema.optional<typeof Schema.Boolean>
  enforceExamples: Schema.optional<typeof Schema.Boolean>
  enforceVersion: Schema.optional<typeof Schema.Boolean>
  exclude: Schema.optional<Schema.Array$<typeof Schema.String>>
  parseCompilerOptions: Schema.optional<
    Schema.Union<[typeof Schema.String, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>]>
  >
  examplesCompilerOptions: Schema.optional<
    Schema.Union<[typeof Schema.String, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>]>
  >
}>

Added in v1.0.0

ConfigurationShape (interface)

Signature

export interface ConfigurationShape {
  readonly projectName: string
  readonly projectHomepage: string
  readonly srcDir: string
  readonly outDir: string
  readonly theme: string
  readonly enableSearch: boolean
  readonly enforceDescriptions: boolean
  readonly enforceExamples: boolean
  readonly enforceVersion: boolean
  readonly runExamples: boolean
  readonly exclude: ReadonlyArray<string>
  readonly parseCompilerOptions: Record<string, unknown>
  readonly examplesCompilerOptions: Record<string, unknown>
}

Added in v1.0.0