表示一个模式。可以是通配符、正则表达式、测试函数或以上模式组成的数组。
表示一个源映射数据,可以是字符串、对象或生成器中的任意一种格式。
表示文件或文件夹的属性对象。
获取全局的异步队列。
文件的生成模式。
是否在控制台显示带颜色的文本。
在未显示完整路径时使用的基路径。
获取所有已完成的任务数。
读写文件使用的默认编码。
获取累积的错误数。
是否允许系统使用源映射信息。
全局事件处理器。
获取已处理的文件数。
是否显示完整路径。
全局匹配器。
允许输出的最低日志等级。
允许输出的最大日志长度。0 表示不限制。
是否允许覆盖源文件。
是否在控制台显示进度。
是否在生成完成后报告结果。
是否允许直接载入全局安装的模块。
自定义写入文件的方法。
当前的开发服务器。
是否启用源映射。
是否在源文件追加对源映射的引用注释。
是否在源映射插入 file 段。
是否在源映射插入 names 段。
是否在源映射插入 sourcesContent 段。
是否在源文件中内联源映射。
用于计算每个文件的源映射路径的回调函数。
源映射中引用源的跟地址。
用于计算源映射中指定源文件地址的回调函数。
用于计算源映射中指定源文件内容的回调函数。
用于计算每个文件的源映射地址的回调函数。
获取本次生成操作的开始时间。
获取所有任务数。
获取累积的警告数。
当前使用的监听器。
为日志字符串添加颜色控制字符。
要处理的字符串。
要添加的颜色。
返回已处理的字符串。
允许 require 从指定的文件夹载入模块。
要载入的模块所在文件夹路径。
在指定文件末尾追加内容。
要创建的文件路径。
要写入的文件数据。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
在指定路径的文件名后追加内容。
要处理的路径。
要追加的内容。
返回已处理的路径。
在指定内容末尾插入一个 #sourceMappingURL 注释。
要插入或更新的内容。
要插入或更新的源映射地址。如果地址为空则删除已存在的注释。
如果为 true 则使用单行注释,否则使用多行注释。
返回已更新的内容。
计算指定数据的 Base64 值。
要处理的字符串或缓存对象。
返回结果字符串。
计算指定数据的 Base64 编码地址。
数据的 MIME 类型。
要处理的字符串或缓存对象。
返回结果字符串。
记录将开始执行指定的任务。
任务内容。
格式化参数。task 中 {x}
会被替换为 args.x
的值。
返回任务序号。
将指定的缓存对象转为字符串。
要处理的缓存对象。
转换的编码。
返回处理后的字符串。BOM 字符会被自动删除。
清空指定的文件夹。
要清空的文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
获取两个路径中的公共文件夹。
要处理的第一个路径。
要处理的第二个路径。
返回公共文件夹绝对路径。如果没有相同部分则返回 null。
设置全局选项。
要设置的选项。
复制指定的文件夹。
复制的源文件夹路径。
复制的目标文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
复制指定的文件夹,如果文件已存在则不复制。
复制的源文件夹路径。
复制的目标文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
复制指定的文件。
复制的源文件路径。
复制的目标文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
复制指定的文件,如果文件已存在则不复制。
复制的源文件路径。
复制的目标文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
复制指定的链接。
复制的源链接。
复制的目标链接。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
复制指定的链接,如果文件已存在则不复制。
复制的源链接。
复制的目标链接。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
创建一个文件夹。
要创建的文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
创建一个链接。
要创建的文件路径。
要链接的目标路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
创建一个链接,如果文件已存在则不写入。
要创建的文件路径。
要链接的目标路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
删除指定的文件夹。
要删除的文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
删除指定的文件,如果文件不存在则直接返回。
要删除的文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
如果父文件夹是空文件夹则删除。
文件夹内的文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
如果指定的日志字符串实际显示宽度超过最大值,则将超出部分替换为 ...
。
要处理的字符串。
允许的最大宽度。如果值小于等于 0 则表示和实际控制台宽度的差。
返回已处理的字符串。
触发一个事件。
要触发的事件名。
传递给监听器的参数列表。
如果事件被成功处理则返回 true,否则返回 false。
在指定内容插入(如果已存在则更新)一个 #sourceMappingURL 注释。
要插入或更新的内容。
要插入或更新的源映射地址。如果地址为空则删除已存在的注释。
插入时如果为 true 则使用单行注释,否则使用多行注释。
返回已更新的内容。
将对象的字符串表示形式转换为 HTML 编码的字符串。
要编码的字符串。
返回已编码的字符串。
记录已执行指定的任务。
要结束的任务序号。
如果指定的路径已存在则执行重命名。
要测试的文件或文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
返回确认不存在的路径。如果 callback 是函数则不返回。
如果指定的路径已存在则执行重命名。
要测试的文件或文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
返回确认不存在的路径。如果 callback 是函数则不返回。
确保已创建指定路径所在的文件夹。
要处理的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
记录一条错误日志。
要记录的日志数据。
格式化参数。日志信息中 {x}
会被替换为 args.x
的值。
同步执行一个命令。
要执行的命令。命令行参数以空格隔开。
执行相关参数。
返回程序的输出内容。
异步执行一个命令。
要执行的命令。命令行参数以空格隔开。
异步执行完成的回调函数。
返回启动的子进程。
异步执行一个命令。
要执行的命令。命令行参数以空格隔开。
执行相关参数。
异步执行完成的回调函数。
返回启动的子进程。
判断指定的文件夹是否已存在。
要判断的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
如果指定的路径是文件夹则返回 true,否则返回 false。如果 callback 是函数则不返回。
判断指定的文件夹是否已存在。
要判断的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
如果指定的路径是文件夹则返回 true,否则返回 false。如果 callback 是函数则不返回。
判断指定的文件是否已存在。
要判断的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
如果指定的路径是文件则返回 true,否则返回 false。如果 callback 是函数则不返回。
判断指定的文件是否已存在。
要判断的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
如果指定的路径是文件则返回 true,否则返回 false。如果 callback 是函数则不返回。
记录一条致命错误日志。
要记录的日志数据。
格式化参数。日志信息中 {x}
会被替换为 args.x
的值。
格式化指定的日志信息。
要处理的日志信息。
格式化参数。日志信息中 {x}
会被替换为 args.x
的值。
返回已格式化的消息。
格式化指定的日期对象。
要处理的日期对象。
格式字符串。其中以下字符(区分大小写)会被替换:
字符 | 意义 | 示例 |
---|---|---|
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 |
返回格式化后的字符串。
格式化指定的高精度时间段。
由秒和纳秒部分组成的数组。
返回格式化后的字符串。
格式化指定的日志字符串。
要格式化的字符串。其中 {x}
会被替换为 args.x
的值;{red:x}
会被替换带颜色控制字符的值。其中可使用的颜色见 ConsoleColor
枚举。
格式化的参数。
返回已处理的字符串。
格式化指定的源码内容。
要处理的源码内容。
允许的最大宽度。如果值小于等于 0 则表示和实际控制台宽度的差。
允许的最大行数。如果值等于 0 则显示所有行。
是否显示行号。
是否显示列信息。
开始行号(从 0 开始)。
开始列号(从 0 开始)。
结束行号(从 0 开始)。
结束列号(从 0 开始)。
返回源码内容。
计算指定文件的校验码。
要计算的文件路径。
文件比较算法。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
提供文件的状态数据可以避免二次查询。
提供文件的内容可以避免二次查询。
操作失败后自动重试的次数。
返回校验码字符串。如果 callback 是函数则不返回。
计算指定文件的校验码。
要计算的文件路径。
文件比较算法。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
提供文件的状态数据可以避免二次查询。
提供文件的内容可以避免二次查询。
操作失败后自动重试的次数。
返回校验码字符串。如果 callback 是函数则不返回。
获取指定路径的文件夹部分。
要处理的路径。
返回文件夹路径。
获取指定路径的友好显示名称。
要处理的路径。
如果 fullPath 为 false 则返回基于 cwd 的相对路径,否则返回绝对路径。
获取指定路径的扩展名(包括点)部分。
要处理的地址。
返回扩展名(包括点)。如果文件名以点前缀,则返回空。
获取指定路径的文件名部分。
要处理的路径。
如果为 true 则包含扩展名,否则不包含扩展名(包括点)。
返回文件名路径。
获取文件或文件夹的属性,如果是链接则返回链接实际引用的文件属性。
要获取的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件属性对象。如果 callback 是函数则不返回。
获取文件或文件夹的属性,如果是链接则返回链接实际引用的文件属性。
要获取的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件属性对象。如果 callback 是函数则不返回。
获取文件或文件夹的属性,如果是链接则返回链接本身的属性。
要获取的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件属性对象。如果 callback 是函数则不返回。
获取文件或文件夹的属性,如果是链接则返回链接本身的属性。
要获取的路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件属性对象。如果 callback 是函数则不返回。
搜索指定通配符匹配的文件。
要搜索的模式或匹配器。
相关的选项。
如果是同步模式则返回所有文件列表。
搜索指定通配符匹配的文件。
要搜索的模式或匹配器。
相关的选项。
如果是同步模式则返回所有文件列表。
判断一个文件夹是否包含指定的路径。
要判断的文件夹路径。
要判断的子文件或文件夹路径。
如果 parent 包含 child 则返回 true,否则返回 false。
计算指定索引对应的行列号。
要处理的字符串。
要计算的索引。
如果提供一个缓存数组则存放一个索引数据以加速检索。
返回对应的行列号。如果索引错误则返回 0,0 位置。
记录一条信息日志。
要记录的日志数据。
格式化参数。日志信息中 {x}
会被替换为 args.x
的值。
初始化新的 digofile.js。
要初始化的框架名。
如果生成成功则返回 true,否则返回 false。
判断指定的路径是否是绝对路径。
要判断的路径。
如果是绝对路径则返回 true,否则返回 false。
判断指定的地址是否是绝对地址。
要判断的地址。
如果是绝对地址则返回 true,否则返回 false。
载入配置文件。
要载入的配置文件路径。
是否更新当前工作目录。
返回配置文件定义的所有任务。如果载入错误则返回 undefined。
计算指定行列号对应的索引。
要处理的字符串。
如果提供一个缓存数组则存放一个索引数据以加速检索。
返回对应的索引。如果行列号错误则返回 0。
计算指定数据的 MD5 值。
要处理的字符串或缓存对象。
返回结果字符串。其中只包含小写十六进制数值。
移动指定的文件夹。
移动的源文件夹路径。
移动的目标文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
移动指定的文件。
移动的源文件路径。
移动的目标文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
规范化指定的路径格式,删除路径中多余的 ./
和 ../
。
要处理的路径。
返回已处理的路径。路径固定以 /
作为分隔符。路径末尾的分隔符会被保留。
规范化指定地址的格式。
要处理的地址。
返回处理后的地址。
解绑一个或多个事件。
要解绑的事件名。如果不传递则解绑所有事件。
要解绑的事件监听器。如果不传递则解绑所有监听器。
绑定一个事件。
要绑定的事件名。
要绑定的事件监听器。
当删除文件后的回调函数。
当前相关的文件。
处理文件时产生日志的回调函数。
当前正在生成的文件。
要记录的日志项。
要记录的日志等级。
如果函数返回 false,则忽略当前日志。
保存文件后的回调函数。
当前相关的文件。
即将保存文件时的回调函数。
当前相关的文件。
如果函数返回 false,则不保存此文件。
生成文件源映射的回调函数。
当前的源映射对象。
当前相关的文件。
解析控制台命令的选项。
要解析的命令行参数列表。
开始解析的索引。
返回已解析的参数键值对。
判断两个路径是否相同。
要判断的第一个路径。
要判断的第二个路径。
如果相同则返回 true,否则返回 false。
载入指定的插件。
要载入的插件名。
返回插件导出对象。
在指定路径的文件名前追加内容。
要处理的路径。
要追加的内容。
返回已处理的路径。
等待命令行输入并继续。
询问的问题。
用户回答后的回调函数。
返回命令行接口。
读取文件夹内的所有项。
要读取的文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件夹内所有项。如果文件夹不存在则返回空数组。如果 callback 是函数则不返回。
读取文件夹内的所有项。
要读取的文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件夹内所有项。如果文件夹不存在则返回空数组。如果 callback 是函数则不返回。
读取文件夹内的所有项,如果文件夹不存在则返回空列表。
要读取的文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件夹内所有项。如果文件夹不存在则返回空数组。如果 callback 是函数则不返回。
读取文件夹内的所有项,如果文件夹不存在则返回空列表。
要读取的文件夹路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件夹内所有项。如果文件夹不存在则返回空数组。如果 callback 是函数则不返回。
读取指定的文件内容。
要读取的文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件二进制内容。如果 callback 是函数则不返回。
读取指定的文件内容。
要读取的文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件二进制内容。如果 callback 是函数则不返回。
读取指定的文件内容,如果文件不存在则返回空数据。
要读取的文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件二进制内容。如果 callback 是函数则不返回。
读取指定的文件内容,如果文件不存在则返回空数据。
要读取的文件路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回文件二进制内容。如果 callback 是函数则不返回。
读取链接的实际地址。
要读取的链接路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回路径。如果 callback 是函数则不返回。
读取链接的实际地址。
要读取的链接路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回路径。如果 callback 是函数则不返回。
读取链接的实际地址,如果文件不存在则返回空数据。
要读取的链接路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回路径。如果 callback 是函数则不返回。
读取链接的实际地址,如果文件不存在则返回空数据。
要读取的链接路径。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
返回路径。如果 callback 是函数则不返回。
解析指定路径对应的相对路径。
要解析的路径。
返回已解析的相对路径。路径固定以 /
作为分隔符。路径末尾多余的分隔符会被删除。
解析指定路径对应的相对路径。
要解析的基路径。
要解析的路径。
返回已解析的相对路径。路径固定以 /
作为分隔符。路径末尾多余的分隔符会被删除。
解析指定地址对应的相对地址。
要解析的基地址。
要解析的相对地址或绝对地址。
返回已解析的地址。
删除日志字符串中的所有控制字符。
要处理的字符串。
返回已处理的字符串。
解析指定路径对应的绝对路径。
要解析的路径。
返回已解析的绝对路径。路径末尾多余的分隔符会被删除。
解析指定路径对应的绝对路径。
要解析的基路径。
要解析的路径。
返回已解析的绝对路径。路径末尾多余的分隔符会被删除。
解析指定模块的绝对路径。
要解析的模块路径。
返回已解析的模块绝对路径。如果找不到模块则返回 undefined。
解析指定地址对应的绝对地址。
要解析的基地址。
要解析的相对地址或绝对地址。
返回已解析的地址。
执行一个任务。
要执行的任务。
任务名。
设置指定路径的文件夹部分。
要处理的路径。
要设置的新文件夹路径。
返回已处理的路径。
设置指定路径的扩展名(包括点)部分。
要处理的路径。
要更改的新扩展名(包括点)。
返回已处理的路径。如果源路径不含扩展名则自动追加。
设置指定路径的文件名部分。
要处理的路径。
要更改的新文件名。
如果为 true 则同时更改扩展名,否则保留原扩展名(包括点)。
返回已处理的路径。如果源路径不含扩展名则自动追加到文件名末尾。
设置一个对象的属性值。
要修改的对象。
要设置的属性名。
要设置的属性值。
返回已修改的对象。
计算指定数据的 SHA1 值。
要处理的字符串或缓存对象。
返回结果字符串。其中只包含小写十六进制数值。
将指定的日志字符串按最大宽度拆成多行。
要处理的字符串。
允许的最大宽度。如果值小于等于 0 则表示和实际控制台宽度的差。
返回包含每行内容的数组。
筛选指定的文件并返回一个文件列表。
用于筛选文件的通配符、正则表达式、函数或以上组合的数组。
返回一个文件列表对象。
启动服务器。
服务器配置。
返回服务器对象。
将指定的字符串转为缓存对象。
要处理的字符串。
转换的编码。
返回处理后的缓存对象。
等待当前任务全部完成后执行指定的任务。
要执行的任务函数。
将指定的源映射数据转为源映射构建器。
要转换的源映射数据。
返回源映射构建器。
将指定的源映射数据转为源映射对象。
要转换的源映射数据。
返回源映射对象。
将指定的源映射数据转为源映射字符串。
要转换的源映射数据。
返回源映射字符串。
更新状态条内容。
要显示的信息。如果为空则清空状态条。
记录一条详细日志。
要记录的日志数据。
格式化参数。日志信息中 {x}
会被替换为 args.x
的值。
深度遍历指定的文件或文件夹并执行回调。
要遍历的文件或文件夹路径。
遍历的选项。
操作失败后自动重试的次数。
记录一条警告日志。
要记录的日志数据。
格式化参数。日志信息中 {x}
会被替换为 args.x
的值。
监听指定的文件并执行回调。
要监听的文件匹配器。匹配器可以是通配符、正则表达式、函数或以上组合的数组。
要执行的任务函数。
执行指定的任务并监听所有生成的文件。
要执行的任务函数。
写入指定的文件内容。
要写入的文件路径。
要写入的文件数据。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
写入指定的文件内容,如果文件已存在则不写入。
要写入的文件路径。
要写入的文件数据。
异步操作完成后的回调函数。如果不是函数则以同步的方式执行。
操作失败后自动重试的次数。
所有消息的本地化版本。
所有支持的配置文件扩展名。
在控制台显示源内容的格式。如果设为 null 则不显示源内容。
最大显示的高度。
是否高亮列。
是否高亮行。
最大显示的宽度。如果小于等于 0 则表示和控制台实际宽度的差。
Generated using TypeDoc
表示一个异步回调函数。
如果函数返回一个确认对象(Promise),则异步队列会自动等待此对象。