# fined [![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. ## Usage ```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' } } ``` ## API ### fined(pathObj, opts) => object | null #### Arguments: * **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. #### Return: 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. ## License MIT [downloads-image]: http://img.shields.io/npm/dm/fined.svg [npm-url]: https://www.npmjs.com/package/fined [npm-image]: http://img.shields.io/npm/v/fined.svg [travis-url]: https://travis-ci.org/gulpjs/fined [travis-image]: http://img.shields.io/travis/gulpjs/fined.svg?label=travis-ci [appveyor-url]: https://ci.appveyor.com/project/gulpjs/fined [appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/fined.svg?label=appveyor [coveralls-url]: https://coveralls.io/r/gulpjs/fined [coveralls-image]: http://img.shields.io/coveralls/gulpjs/fined/master.svg [gitter-url]: https://gitter.im/gulpjs/gulp [gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg