Class FileList

表示一个文件列表。

Hierarchy

FileList
- RootFileList

Index

Accessors

result
root

Methods

Accessors

result

get result(): FileList

- Defined in lib/builder/fileList.ts:37
获取当前列表的最终结果列表。

Returns FileList

root

get root(): FileList

- Defined in lib/builder/fileList.ts:26
获取当前列表的根列表。

Returns FileList

Methods

add

add(file: File, root?: FileList): void

- Defined in lib/builder/fileList.ts:81
向当前列表添加一个文件。

Parameters
- file: File
  
  要添加的文件。
- Default value root: FileList = this
  
  文件所属的根列表。
Returns void

clone

clone(): FileList

- Defined in lib/builder/fileList.ts:368
创建当前列表所有文件的副本。

Returns FileList

返回用于接收处理后文件的文件列表。

delete

delete(deleteDir?: boolean): FileList

- Defined in lib/builder/fileList.ts:356
删除所有源文件。

Parameters
- Default value deleteDir: boolean = true
  
  指示是否删除空的父文件夹。
Returns FileList

返回用于接收处理后文件的文件列表。

dest

dest(dir?: string): FileList

- Defined in lib/builder/fileList.ts:343
将所有文件移动到指定的文件夹。

Parameters
- Default value dir: string = ""
  
  要保存的目标文件文件夹。如果为空则保存到原文件夹。
Returns FileList

返回用于接收处理后文件的文件列表。

Protected done

done(): void

- Defined in lib/builder/fileList.ts:246
当作为顶级列表时表示所有子列表执行完成后的回调。

Returns void

end

end(): void

- Defined in lib/builder/fileList.ts:99
通知当前列表所有文件已添加。

Returns void

pipe

pipe<T>(processor: string | add | Processor<T>, options?: T): FileList

- Defined in lib/builder/fileList.ts:275
将当前列表所有文件传递给指定的处理器。

example

list.pipe((file) => file.content += "1"); list.pipe((file, options, done) => done());

Type parameters
- T
Parameters
- processor: string | add | Processor<T>
  
  要传递的目标处理器。
- Default value options: T = emptyObject
  
  供处理器使用的只读配置对象。
Returns FileList

返回用于接收处理后文件的文件列表。

src

src(...patterns: Pattern[]): FileList

- Defined in lib/builder/fileList.ts:330
筛选当前文件列表并返回一个新的文件列表。

Parameters
- Rest ...patterns: Pattern[]
  
  用于筛选文件的通配符、正则表达式、函数或以上模式组合的数组。
Returns FileList

返回已筛选的文件列表。

then

then(callback: function): FileList

- Defined in lib/builder/fileList.ts:309
设置当前列表完成后的回调函数。

Parameters
- callback: function
  
  要执行的回调函数。
  - - (done: function): void
    - Parameters
      - done: function
        
        (): void
        
        Returns void
      Returns void
Returns FileList

返回用于接收处理后文件的文件列表。

Generated using TypeDoc