Needless Patchouli Manufacture

    file-url
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.0 • Public • Published

    file-url

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

    Install

    $ npm install file-url
    

    Usage

    import fileUrl from '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.

    Related

    Install

    npm i file-url

    DownloadsWeekly Downloads

    185,098

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    3.99 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus