История

github-actions[bot] 0da815296a Update checked-in dependencies		2022-02-24 17:03:29 +00:00
..
index.d.ts	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
index.js	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
license	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
package.json	Update checked-in dependencies	2022-02-24 17:03:29 +00:00
readme.md	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00

readme.md

file-url

Convert a file path to a file url: unicorn.jpg → file:///Users/sindresorhus/unicorn.jpg

Install

$ npm install file-url

Usage

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
Default: true

Passing false will make it not call path.resolve() on the path.

file-url-cli - CLI for this module