read-fallback
Install
$ npm install --save read-fallback
Usage
Assume that I have a foo.txt
with content bar
:
const read = // it looks for foo.md, sure it does not exist// then it looks for foo.txt, there it is// the last foo.xxx is skipped // use an array of file paths directly// because sometimes the filename is different too
API
readFallback(input, [options])
input
Type: string
or array
An array of file paths or a single file name.
options
extensions
Type: array
Used when input
is a string, eg:
// looks for gulpfile.js then gulpfile.babel.js // if no extensions:// it simply reads `foo` only, without any extension// but yeah, it's not a common case
handler
Type: function
Specific a handler function for reading file content, by default it's a promisified fs.readFile
and returns {file, content}
in the end.
Any function which returns a Promise or does synchronus operations is valid.
// you don't know what you have// but if a.js exists you do this// if a.ts exists you do that
skipHandler
Type: boolean
Default: false
Simply return matched file path instead of using a handler function to read its content. In this way:
// assume we have b.js
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D