Class GlobStream<O>

basic walking utilities that all the glob walker types use

Type Parameters

O extends GlobWalkerOpts = GlobWalkerOpts

Hierarchy (view full)

GlobUtil<O>
- GlobStream

Index

Constructors

constructor

new GlobStream<O>(patterns, path, opts): GlobStream<O>
Type Parameters
- O extends GlobWalkerOpts = GlobWalkerOpts
Parameters
- patterns: Pattern[]
- path: Path
- opts: O
Returns GlobStream<O>
Overrides GlobUtil.constructor
- Defined in src/walker.ts:462

Properties

aborted

aborted: boolean = false

includeChildMatches

includeChildMatches: boolean

maxDepth

maxDepth: number

opts

opts: O

path

path: Path

patterns

patterns: Pattern[]

paused

paused: boolean = false

results

results: Minipass<Result<O>, Result<O>, Events<Result<O>>>

seen

seen: Set<Path> = ...

`Optional`signal

signal?: AbortSignal

Methods

match

match(e, absolute, ifDir): Promise<void>
Parameters
- e: Path
- absolute: boolean
- ifDir: boolean
Returns Promise<void>
Inherited from GlobUtil.match
- Defined in src/walker.ts:250

matchCheck

matchCheck(e, ifDir): Promise<undefined | Path>
Parameters
- e: Path
- ifDir: boolean
Returns Promise<undefined | Path>
Inherited from GlobUtil.matchCheck
- Defined in src/walker.ts:164

matchCheckSync

matchCheckSync(e, ifDir): undefined | Path
Parameters
- e: Path
- ifDir: boolean
Returns undefined | Path
Inherited from GlobUtil.matchCheckSync
- Defined in src/walker.ts:201

matchCheckTest

matchCheckTest(e, ifDir): undefined | Path
Parameters
- e: undefined | Path
- ifDir: boolean
Returns undefined | Path
Inherited from GlobUtil.matchCheckTest
- Defined in src/walker.ts:185

matchEmit

matchEmit(e): void
Parameters
- e: Result<O>
Returns void
Overrides GlobUtil.matchEmit
- Defined in src/walker.ts:472

matchFinish

matchFinish(e, absolute): void
Parameters
- e: Path
- absolute: boolean
Returns void
Inherited from GlobUtil.matchFinish
- Defined in src/walker.ts:223

matchSync

matchSync(e, absolute, ifDir): void
Parameters
- e: Path
- absolute: boolean
- ifDir: boolean
Returns void
Inherited from GlobUtil.matchSync
- Defined in src/walker.ts:255

onResume

onResume(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from GlobUtil.onResume
- Defined in src/walker.ts:151

pause

pause(): void
Returns void
Inherited from GlobUtil.pause
- Defined in src/walker.ts:138

resume

resume(): void
Returns void
Inherited from GlobUtil.resume
- Defined in src/walker.ts:141

stream

stream(): MatchStream<O>
Returns MatchStream<O>
- Defined in src/walker.ts:477

streamSync

streamSync(): MatchStream<O>
Returns MatchStream<O>
- Defined in src/walker.ts:489

walkCB

walkCB(target, patterns, cb): void
Parameters
- target: Path
- patterns: Pattern[]
- cb: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from GlobUtil.walkCB
- Defined in src/walker.ts:260

walkCB2

walkCB2(target, patterns, processor, cb): any
Parameters
- target: Path
- patterns: Pattern[]
- processor: Processor
- cb: (() => any)
  - - (): any
    - Returns any
Returns any
Inherited from GlobUtil.walkCB2
- Defined in src/walker.ts:267

walkCB2Sync

walkCB2Sync(target, patterns, processor, cb): any
Parameters
- target: Path
- patterns: Pattern[]
- processor: Processor
- cb: (() => any)
  - - (): any
    - Returns any
Returns any
Inherited from GlobUtil.walkCB2Sync
- Defined in src/walker.ts:347

walkCB3

walkCB3(target, entries, processor, cb): void
Parameters
- target: Path
- entries: Path[]
- processor: Processor
- cb: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from GlobUtil.walkCB3
- Defined in src/walker.ts:314

walkCB3Sync

walkCB3Sync(target, entries, processor, cb): void
Parameters
- target: Path
- entries: Path[]
- processor: Processor
- cb: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from GlobUtil.walkCB3Sync
- Defined in src/walker.ts:388

walkCBSync

walkCBSync(target, patterns, cb): void
Parameters
- target: Path
- patterns: Pattern[]
- cb: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from GlobUtil.walkCBSync
- Defined in src/walker.ts:340