Interface WalkOptions

表示遍历的选项。

Hierarchy

WalkOptions
- GlobOptions

Index

Properties

Methods

Properties

Optional entries

entries: object

所有文件列表的缓存对象。

Type declaration

[path: string]: string[] | function[]

Optional follow

follow: boolean

是否解析链接。

Optional stats

stats: object

所有文件属性的缓存对象。

Type declaration

[path: string]: Stats | function[]

Methods

Optional dir

dir(path: string, stats: Stats): boolean | void

- Defined in lib/utility/fs.ts:677
处理一个文件夹的回调函数。

Parameters
- path: string
  
  当前文件夹的绝对路径。
- stats: Stats
  
  当前文件夹的属性对象。
Returns boolean | void

如果函数返回 false 表示不继续遍历此文件夹。

Optional end

end(data?: any): void

- Defined in lib/utility/fs.ts:695
遍历结束的回调函数。

Parameters
- Optional data: any
Returns void

Optional error

error(error: ErrnoException): void

- Defined in lib/utility/fs.ts:690
处理错误的回调函数。

Parameters
- error: ErrnoException
  
  出现的错误对象。
Returns void

Optional file

file(path: string, stats: Stats): void

- Defined in lib/utility/fs.ts:669
处理一个文件的回调函数。

Parameters
- path: string
  
  当前文件的绝对路径。
- stats: Stats
  
  当前文件的属性对象。
Returns void

Optional other

other(path: string, stats: Stats): void

- Defined in lib/utility/fs.ts:684
处理一个其它类型文件的回调函数。

Parameters
- path: string
  
  当前文件的绝对路径。
- stats: Stats
  
  当前文件的属性对象。
Returns void

Optional walk

walk(path: string, stats: Stats, entries?: string[]): boolean | void

- Defined in lib/utility/fs.ts:662
在遍历文件夹前的回调函数。

Parameters
- path: string
  
  当前文件的绝对路径。
- stats: Stats
  
  当前文件的属性对象。
- Optional entries: string[]
  
  当前文件夹下的所有项。
Returns boolean | void

如果函数返回 false 表示不继续遍历此文件夹。

Generated using TypeDoc