Function sync

sync(pattern, options): string[]
Synchronous form of glob
Parameters
- pattern: string | string[]
- options: GlobOptionsWithFileTypesFalse
Returns string[]
- Defined in src/index.ts:202
sync(pattern, options): Path[]
Parameters
- pattern: string | string[]
- options: GlobOptionsWithFileTypesTrue
Returns Path[]
- Defined in src/index.ts:202
sync(pattern, options?): string[]
Parameters
- pattern: string | string[]
- Optionaloptions: GlobOptionsWithFileTypesUnset
Returns string[]
- Defined in src/index.ts:202
sync(pattern, options): Path[] | string[]
Parameters
- pattern: string | string[]
- options: GlobOptions
Returns Path[] | string[]
- Defined in src/index.ts:202

Index

Properties

iterate

iterate: {
    (pattern: string | string[], options?: GlobOptionsWithFileTypesUnset): Generator<string, void, void>;
    (pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Generator<Path, void, void>;
    (pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Generator<string, void, void>;
    (pattern: string | string[], options: GlobOptions): Generator<Path, void, void> | Generator<string, void, void>;
} = globIterateSync

Type declaration

- (pattern, options?): Generator<string, void, void>
- Return a sync iterator for walking glob pattern matches.
  Parameters
  - pattern: string | string[]
  - Optionaloptions: GlobOptionsWithFileTypesUnset
  Returns Generator<string, void, void>
- (pattern, options): Generator<Path, void, void>
- Parameters
  - pattern: string | string[]
  - options: GlobOptionsWithFileTypesTrue
  Returns Generator<Path, void, void>
- (pattern, options): Generator<string, void, void>
- Parameters
  - pattern: string | string[]
  - options: GlobOptionsWithFileTypesFalse
  Returns Generator<string, void, void>
- (pattern, options): Generator<Path, void, void> | Generator<string, void, void>
- Parameters
  - pattern: string | string[]
  - options: GlobOptions
  Returns Generator<Path, void, void> | Generator<string, void, void>

stream

stream: {
    (pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Minipass<Path, Path>;
    (pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Minipass<string, string>;
    (pattern: string | string[], options: GlobOptionsWithFileTypesUnset): Minipass<string, string>;
    (pattern: string | string[], options: GlobOptions): Minipass<Path, Path> | Minipass<string, string>;
} = globStreamSync

Type declaration

- (pattern, options): Minipass<Path, Path>
- Syncronous form of globStream. Will read all the matches as fast as you consume them, even all in a single tick if you consume them immediately, but will still respond to backpressure if they're not consumed immediately.
  Parameters
  - pattern: string | string[]
  - options: GlobOptionsWithFileTypesTrue
  Returns Minipass<Path, Path>
- (pattern, options): Minipass<string, string>
- Parameters
  - pattern: string | string[]
  - options: GlobOptionsWithFileTypesFalse
  Returns Minipass<string, string>
- (pattern, options): Minipass<string, string>
- Parameters
  - pattern: string | string[]
  - options: GlobOptionsWithFileTypesUnset
  Returns Minipass<string, string>
- (pattern, options): Minipass<Path, Path> | Minipass<string, string>
- Parameters
  - pattern: string | string[]
  - options: GlobOptions
  Returns Minipass<Path, Path> | Minipass<string, string>

Function sync

Parameters

Returns string[]

Parameters

Returns Path[]

Parameters

Returns string[]

Parameters

Returns Path[] | string[]

Index

Properties

Properties

iterate

Type declaration

Parameters

Returns Generator<string, void, void>

Parameters

Returns Generator<Path, void, void>

Parameters

Returns Generator<string, void, void>

Parameters

Returns Generator<Path, void, void> | Generator<string, void, void>

stream

Type declaration

Parameters

Returns Minipass<Path, Path>

Parameters

Returns Minipass<string, string>

Parameters

Returns Minipass<string, string>

Parameters

Returns Minipass<Path, Path> | Minipass<string, string>

Settings

On This Page