Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GlobOptions

表示搜索通配符的选项。

Hierarchy

Index

Properties

Optional cwd

cwd: string

搜索的根路径。

Optional entries

entries: object

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

Type declaration

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

Optional follow

follow: boolean

是否解析链接。

Optional globalMatcher

globalMatcher: Matcher

全局匹配器。如果设置了全局匹配器,则返回当前匹配器和全局匹配器的交集。

Optional stats

stats: object

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

Type declaration

  • [path: string]: Stats | function[]

Methods

Optional dir

  • dir(path: string, stats: Stats): boolean | void
  • 处理一个文件夹的回调函数。

    Parameters

    • path: string

      当前文件夹的绝对路径。

    • stats: Stats

      当前文件夹的属性对象。

    Returns boolean | void

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

Optional end

  • end(data?: any): void

Optional error

  • error(error: ErrnoException): void

Optional file

  • file(path: string, stats: Stats): void
  • 处理一个文件的回调函数。

    Parameters

    • path: string

      当前文件的绝对路径。

    • stats: Stats

      当前文件的属性对象。

    Returns void

Optional ignored

  • ignored(path: string, stats: Stats, global: boolean): void
  • 当忽略一个文件或文件夹时执行。

    Parameters

    • path: string

      当前相关的路径。

    • stats: Stats

      当前文件的属性。

    • global: boolean

      如果为 true 则表示被全局匹配器忽略。

    Returns void

Optional other

  • other(path: string, stats: Stats): void
  • 处理一个其它类型文件的回调函数。

    Parameters

    • path: string

      当前文件的绝对路径。

    • stats: Stats

      当前文件的属性对象。

    Returns void

Optional walk

  • walk(path: string, stats: Stats, entries?: string[]): boolean | void
  • 在遍历文件夹前的回调函数。

    Parameters

    • path: string

      当前文件的绝对路径。

    • stats: Stats

      当前文件的属性对象。

    • Optional entries: string[]

      当前文件夹下的所有项。

    Returns boolean | void

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

Generated using TypeDoc