pathToFileURL - url - Node documentation

Node

pathToFileURL

function pathToFileURL

#pathToFileURL(path: string,
options?: PathToFileUrlOptions,
): URL

This function ensures that path is resolved absolutely, and that the URL control characters are correctly encoded when converting into a File URL.

import { pathToFileURL } from 'node:url';

new URL('/foo#1', 'file:');           // Incorrect: file:///foo#1
pathToFileURL('/foo#1');              // Correct:   file:///foo%231 (POSIX)

new URL('/some/path%.c', 'file:');    // Incorrect: file:///some/path%.c
pathToFileURL('/some/path%.c');       // Correct:   file:///some/path%25.c (POSIX)

Parameters #

#path: string

The path to convert to a File URL.

optional

#options: PathToFileUrlOptions

Return Type #

URL

The file URL object.