Glob

Usage

Command Line Interface

`glob(pattern: string | string[], options?: GlobOptions) => Promise`

`globSync(pattern: string | string[], options?: GlobOptions) => string[] | Path[]`

`globIterate(pattern: string | string[], options?: GlobOptions) => AsyncGenerator`

`globIterateSync(pattern: string | string[], options?: GlobOptions) => Generator`

`globStream(pattern: string | string[], options?: GlobOptions) => Minipass`

`globStreamSync(pattern: string | string[], options?: GlobOptions) => Minipass`

`hasMagic(pattern: string | string[], options?: GlobOptions) => boolean`

`escape(pattern: string, options?: GlobOptions) => string`

`unescape(pattern: string, options?: GlobOptions) => string`

Class `Glob`

`const g = new Glob(pattern: string | string[], options: GlobOptions)`

`g.stream()`

`g.streamSync()`

`g.iterate()`

`g.iterateSync()`

`g.walk()`

`g.walkSync()`

Properties

Options

Glob Primer

Dots

Basename Matching

Empty Sets

Comparisons to other fnmatch/glob implementations

Repeated Slashes

Comments and Negation

Windows

Windows, CWDs, Drive Letters, and UNC Paths

UNC Paths

Drive Letters

Race Conditions

See Also:

Glob Logo

Contributing

Comparison to Other JavaScript Glob Implementations

Benchmark Results