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

Config overview

Added in v0.6.0


Table of contents


model

Config (interface)

Signature

export interface Config {
  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 exclude: ReadonlyArray<string>
  readonly parseCompilerOptions: Record<string, unknown>
  readonly examplesCompilerOptions: Record<string, unknown>
}

Added in v0.6.4

utils

decode

Signature

export declare const decode: (input: unknown) => E.Either<string, Partial<Config>>

Added in v0.6.4