DirectoryScanner
Nodepod API / src / readdirp / DirectoryScanner
Interface: DirectoryScanner
Section titled “Interface: DirectoryScanner”Defined in: src/polyfills/readdirp.ts:37
Properties
Section titled “Properties”cfg:
ScanOptions
Defined in: src/polyfills/readdirp.ts:38
handlerMap
Section titled “handlerMap”handlerMap:
Map<string, (…args) =>void[]>
Defined in: src/polyfills/readdirp.ts:42
results
Section titled “results”results:
ScanEntry[]
Defined in: src/polyfills/readdirp.ts:40
rootDir
Section titled “rootDir”rootDir:
string
Defined in: src/polyfills/readdirp.ts:39
scanned
Section titled “scanned”scanned:
boolean
Defined in: src/polyfills/readdirp.ts:41
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator]():
AsyncIterableIterator<ScanEntry>
Defined in: src/polyfills/readdirp.ts:43
Returns
Section titled “Returns”AsyncIterableIterator<ScanEntry>
applyFilter()
Section titled “applyFilter()”applyFilter(
entry,filter?):boolean
Defined in: src/polyfills/readdirp.ts:51
Parameters
Section titled “Parameters”filter?
Section titled “filter?”string | string[] | ((e) => boolean)
Returns
Section titled “Returns”boolean
crawl()
Section titled “crawl()”crawl(
dir,level,relative):void
Defined in: src/polyfills/readdirp.ts:50
Parameters
Section titled “Parameters”string
number
relative
Section titled “relative”string
Returns
Section titled “Returns”void
fireEvent()
Section titled “fireEvent()”fireEvent(
event, …args):void
Defined in: src/polyfills/readdirp.ts:48
Parameters
Section titled “Parameters”string
…unknown[]
Returns
Section titled “Returns”void
globMatch()
Section titled “globMatch()”globMatch(
filename,pattern):boolean
Defined in: src/polyfills/readdirp.ts:52
Parameters
Section titled “Parameters”filename
Section titled “filename”string
pattern
Section titled “pattern”string
Returns
Section titled “Returns”boolean
off(
event,handler):this
Defined in: src/polyfills/readdirp.ts:47
Parameters
Section titled “Parameters”string
handler
Section titled “handler”(…args) => void
Returns
Section titled “Returns”this
on(
event,handler):this
Defined in: src/polyfills/readdirp.ts:45
Parameters
Section titled “Parameters”string
handler
Section titled “handler”(…args) => void
Returns
Section titled “Returns”this
once()
Section titled “once()”once(
event,handler):this
Defined in: src/polyfills/readdirp.ts:46
Parameters
Section titled “Parameters”string
handler
Section titled “handler”(…args) => void
Returns
Section titled “Returns”this
runScan()
Section titled “runScan()”runScan():
void
Defined in: src/polyfills/readdirp.ts:49
Returns
Section titled “Returns”void
toArray()
Section titled “toArray()”toArray():
Promise<ScanEntry[]>
Defined in: src/polyfills/readdirp.ts:44
Returns
Section titled “Returns”Promise<ScanEntry[]>