function

pathToFileURL

path: string

): URL;

Convert a filesystem path to a file:// URL.

@param path

The path to convert.

@returns

A URL with the file:// scheme.

const url = Bun.pathToFileURL("/foo/bar.txt");
console.log(url.href); // "file:///foo/bar.txt"

Internally, this function uses WebKit's URL API to convert the path to a file:// URL.

Referenced types

The URL interface represents an object providing static methods used for creating object URLs.

hash: string
MDN Reference
host: string
MDN Reference
hostname: string
MDN Reference
href: string
MDN Reference
readonly origin: string
MDN Reference
password: string
MDN Reference
pathname: string
MDN Reference
port: string
MDN Reference
protocol: string
MDN Reference
search: string
MDN Reference
readonly searchParams: URLSearchParams
MDN Reference
username: string
MDN Reference
toJSON(): string;
MDN Reference
toString(): string;
The toString() method on the URL object returns the serialized URL. The value returned is equivalent to that of href and toJSON.
static canParse(
url: string | URL,
base?: string | URL
): boolean;
MDN Reference
static createObjectURL(
obj: Blob | MediaSource
): string;
MDN Reference
static parse(
url: string | URL,
base?: string | URL
): null | URL;
MDN Reference
static revokeObjectURL(
url: string
): void;
MDN Reference