Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Config

表示全局选项。

Hierarchy

  • Config

Index

Properties

Optional buildMode

buildMode: BuildMode | "build" | "clean" | "preview"

文件的生成模式。

Optional colors

colors: boolean

是否在控制台显示带颜色的文本。

Optional dict

dict: object

所有消息的本地化版本。

Type declaration

  • [message: string]: string

Optional displayRoot

displayRoot: any

在未显示完整路径时使用的基路径。

Optional encoding

encoding: string

读写文件使用的默认编码。

Optional evalSourceMap

evalSourceMap: boolean

是否允许生成器使用源映射进行定位。

Optional filter

filter: Pattern

全局筛选的文件或文件夹地址。

Optional fullPath

fullPath: boolean

是否显示完整路径。

Optional ignore

ignore: Pattern

全局忽略的文件或文件夹地址。

Optional ignoreFile

ignoreFile: string

全局载入的忽略文件地址(如 .gitignore)。

Optional logLevel

logLevel: LogLevel | "verbose" | "log" | "info" | "warning" | "error" | "fatal" | "slient"

允许输出的最低日志等级。

Optional logMaxLength

logMaxLength: number

允许输出的最大日志长度。0 表示不限制。

Optional logSource

logSource: boolean | object

在控制台显示源内容的格式。如果设为 false 则不显示源内容。

Optional overwrite

overwrite: boolean

是否允许覆盖源文件。

Optional progress

progress: boolean

是否在控制台显示进度条。

Optional report

report: boolean

是否在生成完成后报告结果。

Optional silent

silent: boolean

是否禁用所有日志。

Optional sourceMap

sourceMap: boolean

是否启用源映射。

Optional sourceMapEmit

sourceMapEmit: boolean

是否在源文件追加对源映射的引用地址。

Optional sourceMapIncludeFile

sourceMapIncludeFile: boolean

是否在源映射插入 file 段。

Optional sourceMapIncludeNames

sourceMapIncludeNames: boolean

是否在源映射插入 names 段。

Optional sourceMapIncludeSourcesContent

sourceMapIncludeSourcesContent: boolean

是否在源映射插入 sourcesContent 段。

Optional sourceMapInline

sourceMapInline: boolean

是否在源文件中内联源映射。

Optional sourceMapPath

sourceMapPath: string | function

用于获取每个文件的源映射路径的回调函数。 字符串中 {name} 代表源文件名。

param

源文件。

Optional sourceMapRoot

sourceMapRoot: string

源映射中引用源的跟地址。

Optional sourceMapSource

sourceMapSource: function

用于获取每个源映射中指定源文件地址的回调函数。

param

指向的源文件。

param

当前文件。

Type declaration

    • (source: string, file: File): string
    • Parameters

      • source: string
      • file: File

      Returns string

Optional sourceMapUrl

sourceMapUrl: string | function

用于获取每个文件的源映射地址的回调函数。 字符串中 {name} 代表源文件名。

param

源文件。

Optional verbose

verbose: boolean

是否显示详细信息。

Generated using TypeDoc