Options
All
  • Public
  • Public/Protected
  • All
Menu

digo

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AsyncCallback

AsyncCallback: function

表示一个异步回调函数。

returns

如果函数返回一个确认对象(Promise),则异步队列会自动等待此对象。

Type declaration

    • (): Promise<any> | void
    • Returns Promise<any> | void

Pattern

Pattern: string | RegExp | function | any[] | Matcher | null

表示一个模式。可以是通配符、正则表达式、测试函数或以上模式组成的数组。

desc
通配符

通配符的语法和 .gitignore 相同。

通配符中可以使用以下特殊字符:

  • *: 匹配任意个 / 以外的字符。
  • **:匹配任意个字符。
  • ?: 匹配一个 / 以外的字符。
  • [abc]: 匹配括号中的任一个字符。
  • [^abc]: 匹配括号中的任一个字符以外的字符。
  • \: 表示转义字符。如 \[

在通配符前面加 !,表示忽略匹配的项(反向匹配)。 注意如果忽略了父文件夹,出于性能考虑,无法重新包含其中的子文件。

如果通配符以 / 结尾,表示只匹配文件夹。

关于 *** 的区别:

  • ** 则匹配任意层目录(包括没有)。比如 usr/**\/foo.js 既匹配 usr/dir/foo.js,也匹配 usr/foo.jsusr/dir/sub/foo.js
  • * 只匹配一层目录。比如 usr/*\/foo.js 匹配 usr/dir/foo.js,但不匹配 usr/foo.js,也不匹配 usr/dir/sub/foo.js
  • 特殊情况:如果通配符不含 /(末尾除外),则两者意义相同:都表示匹配任意层目录。比如 *.js 既匹配 foo.js 也匹配 usr/foo.js。如果希望只匹配当前目录下的文件,应该写成 ./*.js

直接使用文件夹名,如 foo/www 等效于 foo/www/**

绝对路径可以直接作通配符使用。

正则表达式

复杂的匹配规则可以使用正则表达式。 测试的源是一个固定以 / 为分隔符的相对路径。

自定义函数

函数接收一个绝对路径为参数,如果函数返回 true 表示匹配该路径。

function match(path) {
    return path.endsWith(".js");
}

SourceMapData

表示一个源映射数据,可以是字符串、对象或生成器中的任意一种格式。

Stats

Stats: Stats

表示文件或文件夹的属性对象。

Variables

asyncQueue

asyncQueue: AsyncQueue = new AsyncQueue()

获取全局的异步队列。

buildMode

buildMode: BuildMode = BuildMode.build

文件的生成模式。

colors

colors: boolean = (process.stdout as WriteStream).isTTY === true && !process.env["NODE_DISABLE_COLORS"]

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

displayRoot

displayRoot: any = process.env["INIT_CWD"] || process.cwd()

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

doneTaskCount

doneTaskCount: number = 0

获取所有已完成的任务数。

encoding

encoding: string = "utf-8"

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

errorCount

errorCount: number = 0

获取累积的错误数。

evalSourceMap

evalSourceMap: boolean = true

是否允许系统使用源映射信息。

events

events: EventEmitter = new EventEmitter()

全局事件处理器。

fileCount

fileCount: number = 0

获取已处理的文件数。

fullPath

fullPath: boolean = false

是否显示完整路径。

globalMatcher

globalMatcher: Matcher = new Matcher()

全局匹配器。

logLevel

logLevel: LogLevel = LogLevel.log

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

logMaxLength

logMaxLength: number = ((process.stdout as WriteStream).columns || 80) * 5

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

overwrite

overwrite: boolean = false

是否允许覆盖源文件。

progress

progress: boolean = (process.stdout as WriteStream).isTTY === true

是否在控制台显示进度。

report

report: boolean = true

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

requireGlobal

requireGlobal: boolean = true

是否允许直接载入全局安装的模块。

saveFile

saveFile: null | function = null

自定义写入文件的方法。

param

当前写入的文件路径。

param

当前写入的文件内容。如果为 null 表示需删除文件。

server

server: Server | null = null

当前的开发服务器。

sourceMap

sourceMap: boolean = false

是否启用源映射。

sourceMapEmit

sourceMapEmit: boolean = true

是否在源文件追加对源映射的引用注释。

sourceMapIncludeFile

sourceMapIncludeFile: boolean = true

是否在源映射插入 file 段。

sourceMapIncludeNames

sourceMapIncludeNames: boolean = true

是否在源映射插入 names 段。

sourceMapIncludeSourcesContent

sourceMapIncludeSourcesContent: boolean = false

是否在源映射插入 sourcesContent 段。

sourceMapInline

sourceMapInline: boolean = false

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

sourceMapPath

sourceMapPath: null | function = null

用于计算每个文件的源映射路径的回调函数。

param

当前相关的文件。

returns

返回源映射的绝对路径。

sourceMapRoot

sourceMapRoot: string = ""

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

sourceMapSource

sourceMapSource: null | function = null

用于计算源映射中指定源文件地址的回调函数。

param

要计算的源文件地址。

param

当前相关的文件。

returns

返回对应的源文件地址。

sourceMapSourceContent

sourceMapSourceContent: null | function = null

用于计算源映射中指定源文件内容的回调函数。

param

要计算的源文件地址。

param

当前相关的文件。

returns

返回对应的源文件内容。

sourceMapUrl

sourceMapUrl: null | function = null

用于计算每个文件的源映射地址的回调函数。

param

当前相关的文件。

returns

返回源映射地址。

startTime

startTime: [number, number]

获取本次生成操作的开始时间。

taskCount

taskCount: number = 0

获取所有任务数。

warningCount

warningCount: number = 0

获取累积的警告数。

watcher

watcher: Watcher | null = null

当前使用的监听器。

Functions

addLogColor

  • 为日志字符串添加颜色控制字符。

    Parameters

    • value: string

      要处理的字符串。

    • color: ConsoleColor

      要添加的颜色。

    Returns string

    返回已处理的字符串。

addRequirePath

  • addRequirePath(...paths: string[]): void
  • 允许 require 从指定的文件夹载入模块。

    Parameters

    • Rest ...paths: string[]

      要载入的模块所在文件夹路径。

    Returns void

appendFile

  • appendFile(path: string, data: string | Buffer, callback?: function, retry?: number): void
  • 在指定文件末尾追加内容。

    Parameters

    • path: string

      要创建的文件路径。

    • data: string | Buffer

      要写入的文件数据。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

appendFileName

  • appendFileName(path: string, value: string): string
  • 在指定路径的文件名后追加内容。

    example

    appendFileName("foo/goo.txt", "_fix") // "foo/goo_fix.txt"

    Parameters

    • path: string

      要处理的路径。

    • value: string

      要追加的内容。

    Returns string

    返回已处理的路径。

appendSourceMapUrl

  • appendSourceMapUrl(content: string, sourceMapUrl: string, singleLineComment?: boolean): string
  • 在指定内容末尾插入一个 #sourceMappingURL 注释。

    Parameters

    • content: string

      要插入或更新的内容。

    • sourceMapUrl: string

      要插入或更新的源映射地址。如果地址为空则删除已存在的注释。

    • Optional singleLineComment: boolean

      如果为 true 则使用单行注释,否则使用多行注释。

    Returns string

    返回已更新的内容。

base64

  • base64(data: string | Buffer): string
  • 计算指定数据的 Base64 值。

    example

    base64("A") // "QQ=="

    Parameters

    • data: string | Buffer

      要处理的字符串或缓存对象。

    Returns string

    返回结果字符串。

base64Uri

  • base64Uri(mimeType: string, data: string | Buffer): string
  • 计算指定数据的 Base64 编码地址。

    example

    base64Uri("text/javascript", "A") // "data:text/javascript;base64,QQ=="

    Parameters

    • mimeType: string

      数据的 MIME 类型。

    • data: string | Buffer

      要处理的字符串或缓存对象。

    Returns string

    返回结果字符串。

begin

  • begin(task: string, args?: Object): string
  • 记录将开始执行指定的任务。

    Parameters

    • task: string

      任务内容。

    • Optional args: Object

      格式化参数。task{x} 会被替换为 args.x 的值。

    Returns string

    返回任务序号。

bufferToString

  • bufferToString(value: Buffer, encoding?: string): string

cleanDir

  • cleanDir(path: string, callback?: function, retry?: number): void
  • 清空指定的文件夹。

    Parameters

    • path: string

      要清空的文件夹路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

commonDir

  • commonDir(path1: string | null, path2: string | null): string
  • 获取两个路径中的公共文件夹。

    example

    commonDir("/root/foo", "/root/foo/goo") // "/root/foo"

    Parameters

    • path1: string | null

      要处理的第一个路径。

    • path2: string | null

      要处理的第二个路径。

    Returns string

    返回公共文件夹绝对路径。如果没有相同部分则返回 null。

config

  • config(configs: Config): void

copyDir

  • copyDir(from: string, to: string, callback?: function, retry?: number): void
  • 复制指定的文件夹。

    Parameters

    • from: string

      复制的源文件夹路径。

    • to: string

      复制的目标文件夹路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

copyDirIf

  • copyDirIf(from: string, to: string, callback?: function, retry?: number): void
  • 复制指定的文件夹,如果文件已存在则不复制。

    Parameters

    • from: string

      复制的源文件夹路径。

    • to: string

      复制的目标文件夹路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

copyFile

  • copyFile(from: string, to: string, callback?: function, retry?: number): void
  • 复制指定的文件。

    Parameters

    • from: string

      复制的源文件路径。

    • to: string

      复制的目标文件路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

copyFileIf

  • copyFileIf(from: string, to: string, callback?: function, retry?: number): void
  • 复制指定的文件,如果文件已存在则不复制。

    Parameters

    • from: string

      复制的源文件路径。

    • to: string

      复制的目标文件路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

copyLink

  • copyLink(from: string, to: string, callback?: function, retry?: number): void
  • 复制指定的链接。

    Parameters

    • from: string

      复制的源链接。

    • to: string

      复制的目标链接。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

copyLinkIf

  • copyLinkIf(from: string, to: string, callback?: function, retry?: number): void
  • 复制指定的链接,如果文件已存在则不复制。

    Parameters

    • from: string

      复制的源链接。

    • to: string

      复制的目标链接。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

createDir

  • createDir(path: string, callback?: function, retry?: number): void
  • 创建一个文件夹。

    Parameters

    • path: string

      要创建的文件夹路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

createLink

  • createLink(path: string, target: string, callback?: function, retry?: number): void
  • 创建一个链接。

    Parameters

    • path: string

      要创建的文件路径。

    • target: string

      要链接的目标路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

createLinkIf

  • createLinkIf(path: string, target: string, callback?: function, retry?: number): void
  • 创建一个链接,如果文件已存在则不写入。

    Parameters

    • path: string

      要创建的文件路径。

    • target: string

      要链接的目标路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

deleteDir

  • deleteDir(path: string, callback?: function, retry?: number): void
  • 删除指定的文件夹。

    Parameters

    • path: string

      要删除的文件夹路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

deleteFile

  • deleteFile(path: string, callback?: function, retry?: number): void
  • 删除指定的文件,如果文件不存在则直接返回。

    Parameters

    • path: string

      要删除的文件路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

deleteParentDirIfEmpty

  • deleteParentDirIfEmpty(path: string, callback?: function, retry?: number): void
  • 如果父文件夹是空文件夹则删除。

    Parameters

    • path: string

      文件夹内的文件路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

ellipsisLog

  • ellipsisLog(value: string, width?: number): string
  • 如果指定的日志字符串实际显示宽度超过最大值,则将超出部分替换为 ...

    Parameters

    • value: string

      要处理的字符串。

    • Default value width: number = 0

      允许的最大宽度。如果值小于等于 0 则表示和实际控制台宽度的差。

    Returns string

    返回已处理的字符串。

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • 触发一个事件。

    Parameters

    • event: string | symbol

      要触发的事件名。

    • Rest ...args: any[]

      传递给监听器的参数列表。

    Returns boolean

    如果事件被成功处理则返回 true,否则返回 false。

emitSourceMapUrl

  • emitSourceMapUrl(content: string, sourceMapUrl: string | null, singleLineComment?: boolean): string
  • 在指定内容插入(如果已存在则更新)一个 #sourceMappingURL 注释。

    Parameters

    • content: string

      要插入或更新的内容。

    • sourceMapUrl: string | null

      要插入或更新的源映射地址。如果地址为空则删除已存在的注释。

    • Optional singleLineComment: boolean

      插入时如果为 true 则使用单行注释,否则使用多行注释。

    Returns string

    返回已更新的内容。

encodeHTML

  • encodeHTML(value: string): string
  • 将对象的字符串表示形式转换为 HTML 编码的字符串。

    Parameters

    • value: string

      要编码的字符串。

    Returns string

    返回已编码的字符串。

end

  • end(task: string): void
  • 记录已执行指定的任务。

    Parameters

    • task: string

      要结束的任务序号。

    Returns void

ensureNewPath

  • ensureNewPath(path: string, callback?: undefined, startId?: number): string
  • ensureNewPath(path: string, callback?: function, startId?: number): void
  • 如果指定的路径已存在则执行重命名。

    Parameters

    • path: string

      要测试的文件或文件夹路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional startId: number

    Returns string

    返回确认不存在的路径。如果 callback 是函数则不返回。

  • 如果指定的路径已存在则执行重命名。

    Parameters

    • path: string

      要测试的文件或文件夹路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (result: string): void
        • Parameters

          • result: string

          Returns void

    • Optional startId: number

    Returns void

    返回确认不存在的路径。如果 callback 是函数则不返回。

ensureParentDir

  • ensureParentDir(path: string, callback?: function, retry?: number): void
  • 确保已创建指定路径所在的文件夹。

    Parameters

    • path: string

      要处理的路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

error

  • error(data: string | Error | LogEntry, args?: object): void
  • 记录一条错误日志。

    Parameters

    • data: string | Error | LogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns void

exec

  • exec(command: string, options?: ExecOptions): SpawnSyncReturns<string>
  • exec(command: string, callback: function): ChildProcess
  • exec(command: string, options: ExecOptions, callback: function): ChildProcess
  • 同步执行一个命令。

    Parameters

    • command: string

      要执行的命令。命令行参数以空格隔开。

    • Optional options: ExecOptions

      执行相关参数。

    Returns SpawnSyncReturns<string>

    返回程序的输出内容。

  • 异步执行一个命令。

    Parameters

    • command: string

      要执行的命令。命令行参数以空格隔开。

    • callback: function

      异步执行完成的回调函数。

        • (status: null | number): void
        • Parameters

          • status: null | number

          Returns void

    Returns ChildProcess

    返回启动的子进程。

  • 异步执行一个命令。

    Parameters

    • command: string

      要执行的命令。命令行参数以空格隔开。

    • options: ExecOptions

      执行相关参数。

    • callback: function

      异步执行完成的回调函数。

        • (status: null | number): void
        • Parameters

          • status: null | number

          Returns void

    Returns ChildProcess

    返回启动的子进程。

existsDir

  • existsDir(path: string, callback?: undefined, retry?: number): boolean
  • existsDir(path: string, callback: function, retry?: number): void
  • 判断指定的文件夹是否已存在。

    Parameters

    • path: string

      要判断的路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns boolean

    如果指定的路径是文件夹则返回 true,否则返回 false。如果 callback 是函数则不返回。

  • 判断指定的文件夹是否已存在。

    Parameters

    • path: string

      要判断的路径。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (result: boolean): void
        • Parameters

          • result: boolean

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    如果指定的路径是文件夹则返回 true,否则返回 false。如果 callback 是函数则不返回。

existsFile

  • existsFile(path: string, callback?: undefined, retry?: number): boolean
  • existsFile(path: string, callback: function, retry?: number): void
  • 判断指定的文件是否已存在。

    Parameters

    • path: string

      要判断的路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns boolean

    如果指定的路径是文件则返回 true,否则返回 false。如果 callback 是函数则不返回。

  • 判断指定的文件是否已存在。

    Parameters

    • path: string

      要判断的路径。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (result: boolean): void
        • Parameters

          • result: boolean

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    如果指定的路径是文件则返回 true,否则返回 false。如果 callback 是函数则不返回。

fatal

  • fatal(data: string | Error | LogEntry, args?: object): void
  • 记录一条致命错误日志。

    Parameters

    • data: string | Error | LogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns void

format

  • format(message: string, args?: object): string
  • 格式化指定的日志信息。

    example

    format("abc{a}{b}", { a: 1, b: 2 }) // "abc1"

    example

    format("abc{0}{1}", [1, 2]) // "abc12"

    Parameters

    • message: string

      要处理的日志信息。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns string

    返回已格式化的消息。

formatDate

  • formatDate(date?: Date, format?: string): string
  • 格式化指定的日期对象。

    example

    formatDate(new Date("2016/01/01 00:00:00")) // "2016/01/01 00:00:00"

    example

    formatDate(new Date("2016/01/01 00:00:00"), "yyyyMMdd") // "20160101"

    see

    https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html

    Parameters

    • Default value date: Date = new Date()

      要处理的日期对象。

    • Default value format: string = "yyyy/MM/dd HH:mm:ss"

      格式字符串。其中以下字符(区分大小写)会被替换:

      字符 意义 示例
      y yyyy: 1999, yy: 99
      M MM: 09, M: 9
      d dd: 09, d: 9
      H 时(24小时制) HH: 13, H: 13
      m mm: 06, m: 6
      s ss: 06, s: 6

    Returns string

    返回格式化后的字符串。

formatHRTime

  • formatHRTime(hrTime: [number, number]): string
  • 格式化指定的高精度时间段。

    example

    formatHRTime([1, 20000000]) // "1.02s"

    Parameters

    • hrTime: [number, number]

      由秒和纳秒部分组成的数组。

    Returns string

    返回格式化后的字符串。

formatLog

  • formatLog(value: string, args?: object): string
  • 格式化指定的日志字符串。

    example

    formatLog("Hello, {bright:name}", {name: "xld"}) // "Hello, \x1b[1mxld\x1b[39m"

    example

    formatLog("Hello, {red:name}", {name: "xld"}) // "Hello, \x1b[31mxld\x1b[39m"

    example

    formatLog("{Error}: {bright:message}", {message: "foo..."}) // "\x1b[31mError\x1b[39m: \x1b[1mfoo...\x1b[39m"

    Parameters

    • value: string

      要格式化的字符串。其中 {x} 会被替换为 args.x 的值;{red:x} 会被替换带颜色控制字符的值。其中可使用的颜色见 ConsoleColor 枚举。

    • Optional args: object

      格式化的参数。

      • [key: string]: any

    Returns string

    返回已处理的字符串。

formatSource

  • formatSource(source: string, width?: number, height?: number, showLine?: boolean, showColumn?: boolean, line?: number, column?: number, endLine?: number, endColumn?: number): string
  • 格式化指定的源码内容。

    Parameters

    • source: string

      要处理的源码内容。

    • Default value width: number = 0

      允许的最大宽度。如果值小于等于 0 则表示和实际控制台宽度的差。

    • Default value height: number = 3

      允许的最大行数。如果值等于 0 则显示所有行。

    • Default value showLine: boolean = true

      是否显示行号。

    • Default value showColumn: boolean = true

      是否显示列信息。

    • Optional line: number

      开始行号(从 0 开始)。

    • Optional column: number

      开始列号(从 0 开始)。

    • Optional endLine: number

      结束行号(从 0 开始)。

    • Optional endColumn: number

      结束列号(从 0 开始)。

    Returns string

    返回源码内容。

getChecksum

  • getChecksum(path: string, comparion?: FileComparion, callback?: undefined, stats?: Stats, buffer?: Buffer, retry?: number): string
  • getChecksum(path: string, comparion: FileComparion, callback: function, stats?: Stats, buffer?: Buffer, retry?: number): void
  • 计算指定文件的校验码。

    Parameters

    • path: string

      要计算的文件路径。

    • Optional comparion: FileComparion

      文件比较算法。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional stats: Stats

      提供文件的状态数据可以避免二次查询。

    • Optional buffer: Buffer

      提供文件的内容可以避免二次查询。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns string

    返回校验码字符串。如果 callback 是函数则不返回。

  • 计算指定文件的校验码。

    Parameters

    • path: string

      要计算的文件路径。

    • comparion: FileComparion

      文件比较算法。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, result: string): void
        • Parameters

          • error: ErrnoException | null
          • result: string

          Returns void

    • Optional stats: Stats

      提供文件的状态数据可以避免二次查询。

    • Optional buffer: Buffer

      提供文件的内容可以避免二次查询。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回校验码字符串。如果 callback 是函数则不返回。

getDir

  • getDir(path: string): string
  • 获取指定路径的文件夹部分。

    example

    getDir("/root/foo.txt") // "/root/"

    Parameters

    • path: string

      要处理的路径。

    Returns string

    返回文件夹路径。

getDisplayName

  • getDisplayName(path: string): string
  • 获取指定路径的友好显示名称。

    Parameters

    • path: string

      要处理的路径。

    Returns string

    如果 fullPath 为 false 则返回基于 cwd 的相对路径,否则返回绝对路径。

getExt

  • getExt(path: string): string
  • 获取指定路径的扩展名(包括点)部分。

    example

    getExt("/root/foo.txt") // ".txt"

    Parameters

    • path: string

      要处理的地址。

    Returns string

    返回扩展名(包括点)。如果文件名以点前缀,则返回空。

getFileName

  • getFileName(path: string, ext?: boolean): string
  • 获取指定路径的文件名部分。

    example

    getFileName("/root/foo.txt") // "foo.txt"

    Parameters

    • path: string

      要处理的路径。

    • Default value ext: boolean = true

      如果为 true 则包含扩展名,否则不包含扩展名(包括点)。

    Returns string

    返回文件名路径。

getStat

  • getStat(path: string, callback?: undefined, retry?: number): Stats
  • getStat(path: string, callback: function, retry?: number): void
  • 获取文件或文件夹的属性,如果是链接则返回链接实际引用的文件属性。

    Parameters

    • path: string

      要获取的路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns Stats

    返回文件属性对象。如果 callback 是函数则不返回。

  • 获取文件或文件夹的属性,如果是链接则返回链接实际引用的文件属性。

    Parameters

    • path: string

      要获取的路径。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, stats: Stats): void
        • Parameters

          • error: ErrnoException | null
          • stats: Stats

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回文件属性对象。如果 callback 是函数则不返回。

getStatLink

  • getStatLink(path: string, callback?: undefined, retry?: number): Stats
  • getStatLink(path: string, callback: function, retry?: number): void
  • 获取文件或文件夹的属性,如果是链接则返回链接本身的属性。

    Parameters

    • path: string

      要获取的路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns Stats

    返回文件属性对象。如果 callback 是函数则不返回。

  • 获取文件或文件夹的属性,如果是链接则返回链接本身的属性。

    Parameters

    • path: string

      要获取的路径。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, stats: Stats): void
        • Parameters

          • error: ErrnoException | null
          • stats: Stats

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回文件属性对象。如果 callback 是函数则不返回。

glob

  • 搜索指定通配符匹配的文件。

    Parameters

    • pattern: Pattern

      要搜索的模式或匹配器。

    • options: GlobOptions | object

      相关的选项。

    Returns void

    如果是同步模式则返回所有文件列表。

  • 搜索指定通配符匹配的文件。

    Parameters

    • pattern: Pattern

      要搜索的模式或匹配器。

    • Optional options: GlobOptions

      相关的选项。

    Returns string[]

    如果是同步模式则返回所有文件列表。

inDir

  • inDir(parent: string, child: string): any
  • 判断一个文件夹是否包含指定的路径。

    example

    inDir("/root", "/root/foo") // true

    example

    inDir("/root/foo", "/root/goo") // false

    Parameters

    • parent: string

      要判断的文件夹路径。

    • child: string

      要判断的子文件或文件夹路径。

    Returns any

    如果 parent 包含 child 则返回 true,否则返回 false。

indexToLocation

  • indexToLocation(value: string, index: number, cache?: number[] | object): Location
  • 计算指定索引对应的行列号。

    Parameters

    • value: string

      要处理的字符串。

    • index: number

      要计算的索引。

    • Optional cache: number[] | object

      如果提供一个缓存数组则存放一个索引数据以加速检索。

    Returns Location

    返回对应的行列号。如果索引错误则返回 0,0 位置。

info

  • info(data: string | Error | LogEntry, args?: object): void
  • 记录一条信息日志。

    Parameters

    • data: string | Error | LogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns void

init

  • init(type?: string): boolean
  • 初始化新的 digofile.js。

    Parameters

    • Optional type: string

      要初始化的框架名。

    Returns boolean

    如果生成成功则返回 true,否则返回 false。

isAbsolutePath

  • isAbsolutePath(path: string): boolean
  • 判断指定的路径是否是绝对路径。

    example

    isAbsolutePath("foo") // false

    Parameters

    • path: string

      要判断的路径。

    Returns boolean

    如果是绝对路径则返回 true,否则返回 false。

isAbsoluteUrl

  • isAbsoluteUrl(url: string): boolean
  • 判断指定的地址是否是绝对地址。

    example

    isAbsoluteUrl("/") // true

    Parameters

    • url: string

      要判断的地址。

    Returns boolean

    如果是绝对地址则返回 true,否则返回 false。

loadDigoFile

  • loadDigoFile(path?: string, updateCwd?: boolean): object
  • 载入配置文件。

    Parameters

    • Default value path: string = "digofile.js"

      要载入的配置文件路径。

    • Default value updateCwd: boolean = true

      是否更新当前工作目录。

    Returns object

    返回配置文件定义的所有任务。如果载入错误则返回 undefined。

    • [key: string]: Function

locationToIndex

  • locationToIndex(value: string, location: Location, cache?: number[] | object): number
  • 计算指定行列号对应的索引。

    Parameters

    • value: string

      要处理的字符串。

    • location: Location
    • Optional cache: number[] | object

      如果提供一个缓存数组则存放一个索引数据以加速检索。

    Returns number

    返回对应的索引。如果行列号错误则返回 0。

log

  • 记录一条日志。

    Parameters

    • data: string | Error | LogEntry

      要记录的日志。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any
    • Default value level: LogLevel = LogLevel.log

      要记录的日志等级。

    Returns void

md5

  • md5(data: string | Buffer): string
  • 计算指定数据的 MD5 值。

    example

    md5("A") // "7fc56270e7a70fa81a5935b72eacbe29"

    Parameters

    • data: string | Buffer

      要处理的字符串或缓存对象。

    Returns string

    返回结果字符串。其中只包含小写十六进制数值。

moveDir

  • moveDir(from: string, to: string, callback?: function, retry?: number): void
  • 移动指定的文件夹。

    Parameters

    • from: string

      移动的源文件夹路径。

    • to: string

      移动的目标文件夹路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

moveFile

  • moveFile(from: string, to: string, callback?: function, retry?: number): void
  • 移动指定的文件。

    Parameters

    • from: string

      移动的源文件路径。

    • to: string

      移动的目标文件路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

normalizePath

  • normalizePath(path: string): string
  • 规范化指定的路径格式,删除路径中多余的 ./../

    example

    normalizePath("foo/") // "foo/"

    example

    normalizePath("./foo.js") // "foo.js"

    Parameters

    • path: string

      要处理的路径。

    Returns string

    返回已处理的路径。路径固定以 / 作为分隔符。路径末尾的分隔符会被保留。

normalizeUrl

  • normalizeUrl(url: string): string
  • 规范化指定地址的格式。

    example

    normalizeUrl("abc/") // "abc/"

    example

    normalizeUrl("./abc.js") // "abc.js"

    Parameters

    • url: string

      要处理的地址。

    Returns string

    返回处理后的地址。

off

  • off(event?: string | symbol, listener?: Function): void
  • 解绑一个或多个事件。

    Parameters

    • Optional event: string | symbol

      要解绑的事件名。如果不传递则解绑所有事件。

    • Optional listener: Function

      要解绑的事件监听器。如果不传递则解绑所有监听器。

    Returns void

on

  • on(event: string | symbol, listener: Function): void
  • 绑定一个事件。

    Parameters

    • event: string | symbol

      要绑定的事件名。

    • listener: Function

      要绑定的事件监听器。

    Returns void

onFileDelete

  • onFileDelete(file: File): void

onFileDep

  • onFileDep(file: File, path: string, source?: LogEntry): boolean | void
  • 处理文件时发现依赖的回调函数。

    Parameters

    • file: File

      当前正在生成的文件。

    • path: string

      要依赖的文件路径。

    • Optional source: LogEntry

      要依赖的文件路径。

    Returns boolean | void

    如果函数返回 false,则忽略当前依赖。

onFileLog

  • 处理文件时产生日志的回调函数。

    Parameters

    • file: File

      当前正在生成的文件。

    • log: FileLogEntry

      要记录的日志项。

    • level: LogLevel

      要记录的日志等级。

    Returns boolean | void

    如果函数返回 false,则忽略当前日志。

onFileRef

  • onFileRef(file: File, path: string, source?: LogEntry): boolean | void
  • 处理文件时发现引用的回调函数。

    Parameters

    • file: File

      当前正在生成的文件。

    • path: string

      要引用的文件路径。

    • Optional source: LogEntry

      要引用的文件路径。

    Returns boolean | void

    如果函数返回 false,则忽略当前引用。

onFileSave

  • onFileSave(file: File): void

onFileValidate

  • onFileValidate(file: File): boolean | void
  • 即将保存文件时的回调函数。

    Parameters

    • file: File

      当前相关的文件。

    Returns boolean | void

    如果函数返回 false,则不保存此文件。

onLog

  • 记录日志时的回调函数。

    Parameters

    • log: LogEntry

      要记录的日志项。

    • level: LogLevel

      要记录的日志等级。

    Returns boolean

    如果函数返回 false,则不在控制台输出当前日志。

onSourceMapValidate

parseArgs

  • parseArgs(argv?: string[], startIndex?: number): object
  • 解析控制台命令的选项。

    Parameters

    • Default value argv: string[] = process.argv

      要解析的命令行参数列表。

    • Default value startIndex: number = 2

      开始解析的索引。

    Returns object

    返回已解析的参数键值对。

    • [name: string]: true | string | string[]

pathEquals

  • pathEquals(path1: string | null, path2: string | null): boolean
  • 判断两个路径是否相同。

    example

    pathEquals("/root", "/root") // true

    Parameters

    • path1: string | null

      要判断的第一个路径。

    • path2: string | null

      要判断的第二个路径。

    Returns boolean

    如果相同则返回 true,否则返回 false。

plugin

  • plugin(name: string): any
  • 载入指定的插件。

    Parameters

    • name: string

      要载入的插件名。

    Returns any

    返回插件导出对象。

prependFileName

  • prependFileName(path: string, value: string): string
  • 在指定路径的文件名前追加内容。

    example

    prependFileName("foo/goo.txt", "fix_") // "foo/fix_goo.txt"

    Parameters

    • path: string

      要处理的路径。

    • value: string

      要追加的内容。

    Returns string

    返回已处理的路径。

question

  • question(message: string, callback: function): ReadLine
  • 等待命令行输入并继续。

    Parameters

    • message: string

      询问的问题。

    • callback: function

      用户回答后的回调函数。

        • (answer: string): boolean | void
        • Parameters

          • answer: string

          Returns boolean | void

    Returns ReadLine

    返回命令行接口。

readDir

  • readDir(path: string, callback?: undefined, retry?: number): string[]
  • readDir(path: string, callback: function, retry?: number): void
  • 读取文件夹内的所有项。

    Parameters

    • path: string

      要读取的文件夹路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns string[]

    返回文件夹内所有项。如果文件夹不存在则返回空数组。如果 callback 是函数则不返回。

  • 读取文件夹内的所有项。

    Parameters

    • path: string

      要读取的文件夹路径。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, entries: string[]): void
        • Parameters

          • error: ErrnoException | null
          • entries: string[]

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回文件夹内所有项。如果文件夹不存在则返回空数组。如果 callback 是函数则不返回。

readDirIf

  • readDirIf(path: string, callback?: undefined, retry?: number): string[]
  • readDirIf(path: string, callback: function, retry?: number): void
  • 读取文件夹内的所有项,如果文件夹不存在则返回空列表。

    Parameters

    • path: string

      要读取的文件夹路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns string[]

    返回文件夹内所有项。如果文件夹不存在则返回空数组。如果 callback 是函数则不返回。

  • 读取文件夹内的所有项,如果文件夹不存在则返回空列表。

    Parameters

    • path: string

      要读取的文件夹路径。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, entries: string[]): void
        • Parameters

          • error: ErrnoException | null
          • entries: string[]

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回文件夹内所有项。如果文件夹不存在则返回空数组。如果 callback 是函数则不返回。

readFile

  • readFile(path: string, callback?: undefined, retry?: number): Buffer
  • readFile(path: string, callback: function, retry?: number): void
  • 读取指定的文件内容。

    Parameters

    • path: string

      要读取的文件路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns Buffer

    返回文件二进制内容。如果 callback 是函数则不返回。

  • 读取指定的文件内容。

    Parameters

    • path: string

      要读取的文件路径。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, buffer: Buffer): void
        • Parameters

          • error: ErrnoException | null
          • buffer: Buffer

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回文件二进制内容。如果 callback 是函数则不返回。

readFileIf

  • readFileIf(path: string, callback?: undefined, retry?: number): Buffer
  • readFileIf(path: string, callback: function, retry?: number): void
  • 读取指定的文件内容,如果文件不存在则返回空数据。

    Parameters

    • path: string

      要读取的文件路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns Buffer

    返回文件二进制内容。如果 callback 是函数则不返回。

  • 读取指定的文件内容,如果文件不存在则返回空数据。

    Parameters

    • path: string

      要读取的文件路径。

    • callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, buffer: Buffer): void
        • Parameters

          • error: ErrnoException | null
          • buffer: Buffer

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回文件二进制内容。如果 callback 是函数则不返回。

readLink

  • readLink(path: string, callback?: undefined, retry?: number): string
  • readLink(path: string, callback?: function, retry?: number): void
  • 读取链接的实际地址。

    Parameters

    • path: string

      要读取的链接路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns string

    返回路径。如果 callback 是函数则不返回。

  • 读取链接的实际地址。

    Parameters

    • path: string

      要读取的链接路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, link: string): void
        • Parameters

          • error: ErrnoException | null
          • link: string

          Returns void

    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回路径。如果 callback 是函数则不返回。

readLinkIf

  • readLinkIf(path: string, callback?: undefined, errorIfNotFound?: boolean, retry?: number): string
  • readLinkIf(path: string, callback?: function, errorIfNotFound?: boolean, retry?: number): void
  • 读取链接的实际地址,如果文件不存在则返回空数据。

    Parameters

    • path: string

      要读取的链接路径。

    • Optional callback: undefined

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

    • Optional errorIfNotFound: boolean
    • Optional retry: number

      操作失败后自动重试的次数。

    Returns string

    返回路径。如果 callback 是函数则不返回。

  • 读取链接的实际地址,如果文件不存在则返回空数据。

    Parameters

    • path: string

      要读取的链接路径。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null, link: string): void
        • Parameters

          • error: ErrnoException | null
          • link: string

          Returns void

    • Optional errorIfNotFound: boolean
    • Optional retry: number

      操作失败后自动重试的次数。

    Returns void

    返回路径。如果 callback 是函数则不返回。

relativePath

  • relativePath(path: string): string
  • relativePath(base: string, path?: string): string
  • 解析指定路径对应的相对路径。

    example

    relativePath("foo/goo/hoo")

    Parameters

    • path: string

      要解析的路径。

    Returns string

    返回已解析的相对路径。路径固定以 / 作为分隔符。路径末尾多余的分隔符会被删除。

  • 解析指定路径对应的相对路径。

    example

    relativePath("foo/goo/hoo", "foo/goo/relative") // "../relative"

    Parameters

    • base: string

      要解析的基路径。

    • Optional path: string

      要解析的路径。

    Returns string

    返回已解析的相对路径。路径固定以 / 作为分隔符。路径末尾多余的分隔符会被删除。

relativeUrl

  • relativeUrl(base: string, url: string): string
  • 解析指定地址对应的相对地址。

    example

    relativeUrl("a/b/c", "a/b/d") // "../d"

    Parameters

    • base: string

      要解析的基地址。

    • url: string

      要解析的相对地址或绝对地址。

    Returns string

    返回已解析的地址。

removeLogColor

  • removeLogColor(value: string): string
  • 删除日志字符串中的所有控制字符。

    Parameters

    • value: string

      要处理的字符串。

    Returns string

    返回已处理的字符串。

resolvePath

  • resolvePath(path: string): string
  • resolvePath(base: string, path: string): string
  • 解析指定路径对应的绝对路径。

    example

    resolvePath("../relative")

    Parameters

    • path: string

      要解析的路径。

    Returns string

    返回已解析的绝对路径。路径末尾多余的分隔符会被删除。

  • 解析指定路径对应的绝对路径。

    example

    resolvePath("foo/goo/hoo", "../relative")

    Parameters

    • base: string

      要解析的基路径。

    • path: string

      要解析的路径。

    Returns string

    返回已解析的绝对路径。路径末尾多余的分隔符会被删除。

resolveRequirePath

  • resolveRequirePath(module: string): string
  • 解析指定模块的绝对路径。

    Parameters

    • module: string

      要解析的模块路径。

    Returns string

    返回已解析的模块绝对路径。如果找不到模块则返回 undefined。

resolveUrl

  • resolveUrl(base: string, url: string): string
  • 解析指定地址对应的绝对地址。

    example

    resolveUrl("a/b/c", "../d") // "a/d"

    Parameters

    • base: string

      要解析的基地址。

    • url: string

      要解析的相对地址或绝对地址。

    Returns string

    返回已解析的地址。

run

  • 执行一个任务。

    Parameters

    • task: AsyncCallback

      要执行的任务。

    • Default value taskName: any = task.name || "<anonymous task>"

      任务名。

    Returns void

setDir

  • setDir(path: string, value: string): string
  • 设置指定路径的文件夹部分。

    example

    setDir("/root/foo.txt", "goo") // "goo/foo.txt"

    Parameters

    • path: string

      要处理的路径。

    • value: string

      要设置的新文件夹路径。

    Returns string

    返回已处理的路径。

setExt

  • setExt(path: string, value: string): string
  • 设置指定路径的扩展名(包括点)部分。

    example

    setExt("/root/foo.txt", ".jpg") // "/root/foo.jpg"

    example

    setExt("/root/foo", ".jpg") // "/root/foo.jpg"

    example

    setExt("/root/foo.txt", "") // "/root/foo"

    Parameters

    • path: string

      要处理的路径。

    • value: string

      要更改的新扩展名(包括点)。

    Returns string

    返回已处理的路径。如果源路径不含扩展名则自动追加。

setFileName

  • setFileName(path: string, value: string, ext?: boolean): string
  • 设置指定路径的文件名部分。

    example

    setFileName("/root/foo.txt", "goo.jpg") // "/root/goo.jpg"

    example

    setFileName("/root/foo.txt", "goo", false) // "/root/goo.jpg"

    Parameters

    • path: string

      要处理的路径。

    • value: string

      要更改的新文件名。

    • Default value ext: boolean = true

      如果为 true 则同时更改扩展名,否则保留原扩展名(包括点)。

    Returns string

    返回已处理的路径。如果源路径不含扩展名则自动追加到文件名末尾。

setProperty

  • setProperty<T>(obj: T, key: keyof T, value: any): T
  • 设置一个对象的属性值。

    example

    setProperty({ myKey: "oldValue" }, "myKey", "newValue") // { myKey: "newValue" }

    Type parameters

    • T

    Parameters

    • obj: T

      要修改的对象。

    • key: keyof T

      要设置的属性名。

    • value: any

      要设置的属性值。

    Returns T

    返回已修改的对象。

sha1

  • sha1(data: string | Buffer): string
  • 计算指定数据的 SHA1 值。

    example

    sha1("A") // "6dcd4ce23d88e2ee9568ba546c007c63d9131c1b"

    Parameters

    • data: string | Buffer

      要处理的字符串或缓存对象。

    Returns string

    返回结果字符串。其中只包含小写十六进制数值。

splitLog

  • splitLog(value: string, width?: number): string[]
  • 将指定的日志字符串按最大宽度拆成多行。

    Parameters

    • value: string

      要处理的字符串。

    • Default value width: number = 0

      允许的最大宽度。如果值小于等于 0 则表示和实际控制台宽度的差。

    Returns string[]

    返回包含每行内容的数组。

src

  • src(...patterns: (string | RegExp | any[] | Matcher | function | File | FileList)[]): RootFileList
  • 筛选指定的文件并返回一个文件列表。

    Parameters

    • Rest ...patterns: (string | RegExp | any[] | Matcher | function | File | FileList)[]

      用于筛选文件的通配符、正则表达式、函数或以上组合的数组。

    Returns RootFileList

    返回一个文件列表对象。

startServer

stringToBuffer

  • stringToBuffer(value: string, encoding?: string): Buffer
  • 将指定的字符串转为缓存对象。

    Parameters

    • value: string

      要处理的字符串。

    • Default value encoding: string = "utf-8"

      转换的编码。

    Returns Buffer

    返回处理后的缓存对象。

then

toSourceMapBuilder

toSourceMapObject

toSourceMapString

  • 将指定的源映射数据转为源映射字符串。

    Parameters

    Returns string

    返回源映射字符串。

updateStatus

  • updateStatus(message?: string | null): void
  • 更新状态条内容。

    Parameters

    • Optional message: string | null

      要显示的信息。如果为空则清空状态条。

    Returns void

verbose

  • verbose(data: string | Error | LogEntry, args?: object): void
  • 记录一条详细日志。

    Parameters

    • data: string | Error | LogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns void

walk

  • walk(path: string, options: WalkOptions, retry?: number): void
  • 深度遍历指定的文件或文件夹并执行回调。

    Parameters

    • path: string

      要遍历的文件或文件夹路径。

    • options: WalkOptions

      遍历的选项。

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

warning

  • warning(data: string | Error | LogEntry, args?: object): void
  • 记录一条警告日志。

    Parameters

    • data: string | Error | LogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns void

watch

  • 监听指定的文件并执行回调。

    Parameters

    • pattern: Pattern

      要监听的文件匹配器。匹配器可以是通配符、正则表达式、函数或以上组合的数组。

    • listener: function

      要执行的任务函数。

        • (event: "create" | "change" | "delete", path: string): void
        • Parameters

          • event: "create" | "change" | "delete"
          • path: string

          Returns void

    Returns FSWatcher

  • 执行指定的任务并监听所有生成的文件。

    Parameters

    Returns Watcher

writeFile

  • writeFile(path: string, data: string | Buffer, callback?: function, retry?: number): void
  • 写入指定的文件内容。

    Parameters

    • path: string

      要写入的文件路径。

    • data: string | Buffer

      要写入的文件数据。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

writeFileIf

  • writeFileIf(path: string, data: string | Buffer, callback?: function, retry?: number): void
  • 写入指定的文件内容,如果文件已存在则不写入。

    Parameters

    • path: string

      要写入的文件路径。

    • data: string | Buffer

      要写入的文件数据。

    • Optional callback: function

      异步操作完成后的回调函数。如果不是函数则以同步的方式执行。

        • (error: ErrnoException | null): void
        • Parameters

          • error: ErrnoException | null

          Returns void

    • Default value retry: number = 3

      操作失败后自动重试的次数。

    Returns void

Object literals

dict

dict: object

所有消息的本地化版本。

___proto__

___proto__: null = null!

extensions

extensions: object

所有支持的配置文件扩展名。

.coffee

.coffee: string[] = ["coffee-script/register", "coffee-script"]

.ts

.ts: string[] = ["ts-node/register", "typescript-node/register", "typescript-register", "typescript-require"]

logSource

logSource: object

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

height

height: number = 3

最大显示的高度。

showColumn

showColumn: boolean = true

是否高亮列。

showLine

showLine: boolean = true

是否高亮行。

width

width: number = 0

最大显示的宽度。如果小于等于 0 则表示和控制台实际宽度的差。

Generated using TypeDoc