@redux-multipurpose/angular-cli
Version:
A multipurpose redux tools angular cli
82 lines (55 loc) • 2.55 kB
Markdown
<p align="center">
<a href="http://gulpjs.com">
<img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
</a>
</p>
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
Find a file given a declaration of locations.
```js
var fined = require('fined');
fined({ path: 'path/to/file', extensions: ['.js', '.json'] });
// => { path: '/absolute/path/to/file.js', extension: '.js' } (if file exists)
// => null (if file does not exist)
var opts = {
name: '.app',
cwd: '.',
extensions: {
'rc': 'default-rc-loader',
'.yml': 'default-yml-loader',
},
};
fined({ path: '.' }, opts);
// => { path: '/absolute/of/cwd/.app.yml', extension: { '.yml': 'default-yml-loader' } }
fined({ path: '~', extensions: { 'rc': 'some-special-rc-loader' } }, opts);
// => { path: '/User/home/.apprc', extension: { 'rc': 'some-special-rc-loader' } }
```
* **pathObj** [string | object] : a path setting for finding a file.
* **opts** [object] : a plain object supplements `pathObj`.
`pathObj` and `opts` can have same properties:
* **path** [string] : a path string.
* **name** [string] : a basename.
* **extensions**: [string | array | object] : extensions.
* **cwd**: a base directory of `path` and for finding up.
* **findUp**: [boolean] : a flag to find up.
This function returns a plain object which consists of following properties if a file exists otherwise null.
* **path** : an absolute path
* **extension** : a string or a plain object of extension.
MIT
[]: http://img.shields.io/npm/dm/fined.svg
[]: https://www.npmjs.com/package/fined
[]: http://img.shields.io/npm/v/fined.svg
[]: https://travis-ci.org/gulpjs/fined
[]: http://img.shields.io/travis/gulpjs/fined.svg?label=travis-ci
[]: https://ci.appveyor.com/project/gulpjs/fined
[]: https://img.shields.io/appveyor/ci/gulpjs/fined.svg?label=appveyor
[]: https://coveralls.io/r/gulpjs/fined
[]: http://img.shields.io/coveralls/gulpjs/fined/master.svg
[]: https://gitter.im/gulpjs/gulp
[]: https://badges.gitter.im/gulpjs/gulp.svg