Class GlobWalker<O>

basic walking utilities that all the glob walker types use

Type Parameters

O extends GlobWalkerOpts = GlobWalkerOpts

Hierarchy (View Summary)

GlobUtil<O>
- GlobWalker

Index

Constructors

constructor

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

Properties

aborted

aborted: boolean = false

includeChildMatches

includeChildMatches: boolean

matches

matches: Set<Result<O>> = ...

maxDepth

maxDepth: number

opts

opts: O

path

path: Path

patterns

patterns: Pattern[]

paused

paused: boolean = false

seen

seen: Set<Path> = ...

`Optional`signal

signal?: AbortSignal

Methods

match

match(e: Path, absolute: boolean, ifDir: boolean): 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: Path, ifDir: boolean): 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: Path, ifDir: boolean): undefined | Path
Parameters
- e: Path
- ifDir: boolean
Returns undefined | Path
Inherited from GlobUtil.matchCheckSync
- Defined in src/walker.ts:201

matchCheckTest

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

matchEmit

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

matchFinish

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

matchSync

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

onResume

onResume(fn: () => any): void
Parameters
- fn: () => 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

walk

walk(): Promise<Set<Result<O>>>
Returns Promise<Set<Result<O>>>
- Defined in src/walker.ts:427

walkCB

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

walkCB2

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

walkCB2Sync

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

walkCB3

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

walkCB3Sync

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

walkCBSync

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

walkSync

walkSync(): Set<Result<O>>
Returns Set<Result<O>>
- Defined in src/walker.ts:444

Class GlobWalker<O>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GlobWalker<O>

Properties

aborted

includeChildMatches

matches

maxDepth

opts

path

patterns

paused

seen

Optionalsignal

Methods

match

Parameters

Returns Promise<void>

matchCheck

Parameters

Returns Promise<undefined | Path>

matchCheckSync

Parameters

Returns undefined | Path

matchCheckTest

Parameters

Returns undefined | Path

matchEmit

Parameters

Returns void

matchFinish

Parameters

Returns void

matchSync

Parameters

Returns void

onResume

Parameters

Returns void

pause

Returns void

resume

Returns void

walk

Returns Promise<Set<Result<O>>>

walkCB

Parameters

Returns void

walkCB2

Parameters

Returns any

walkCB2Sync

Parameters

Returns any

walkCB3

Parameters

Returns void

walkCB3Sync

Parameters

Returns void

walkCBSync

Parameters

Returns void

walkSync

Returns Set<Result<O>>

Settings

On This Page

`Optional`signal