Skip to content
Permalink
9bfb9ba527
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
0 contributors

Users who have contributed to this file

59 lines (32 sloc) 1.01 KB
# file-url [![Build Status](https://travis-ci.org/sindresorhus/file-url.svg?branch=master)](https://travis-ci.org/sindresorhus/file-url)
> Convert a file path to a file url: `unicorn.jpg``file:///Users/sindresorhus/unicorn.jpg`
## Install
```
$ npm install file-url
```
## Usage
```js
const fileUrl = require('file-url');
fileUrl('unicorn.jpg');
//=> 'file:///Users/sindresorhus/dev/file-url/unicorn.jpg'
fileUrl('/Users/pony/pics/unicorn.jpg');
//=> 'file:///Users/pony/pics/unicorn.jpg'
fileUrl('unicorn.jpg', {resolve: false});
//=> 'file:///unicorn.jpg'
```
## API
### fileUrl(filePath, [options])
Returns the `filePath` converted to a file URL.
#### filePath
Type: `string`
File path to convert.
#### options
Type: `Object`
##### resolve
Type: `boolean`<br>
Default: `true`
Passing `false` will make it not call `path.resolve()` on the path.
## Related
- [file-url-cli](https://github.com/sindresorhus/file-url-cli) - CLI for this module
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)