read-glob
Search files with glob pattern and read them, Observable way
const readGlob = ; ;
Installation
npm install read-glob
API
const readGlob = ;
readGlob(pattern [, options])
pattern: string
(glob pattern)
options: Object
(node-glob
and fs.readFile
options) or string
(encoding)
Return: Observable
(zenparsing's implementation)
When the Observable
is subscribed, it starts to search files matching the given glob pattern, read their contents and successively send results to its Observer
.
Results
Each result is the same Object
as glob-observable
's with the additional contents
property, a Buffer
or string
of the matched file contents.
contents
is a string
when the encoding
option is specified, otherwise it's a Buffer
.
; ; ;
options
The option object will be directly passed to node-glob
and fs.readFile
, or the encoding string sets the encoding of fs.readFile
.
Unlike the original node-glob API,
silent
andstrict
options aretrue
by default.nodir
andmark
options are not supported as it ignores directories by default.
const readGlob = ; // ./directory/.dot.txt: 'Hello' ;
Related project
- read-glob-promise (Promise version)
License
ISC License © 2017 - 2018 Shinnosuke Watanabe