Bun.pathToFileURL function | API Reference | Bun

Bun.pathToFileURL function | API Reference | BunBuildDocsReferenceGuidesBlogDiscord/Bun/pathToFileURLFpathToFileURL

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/Bun/pathToFileURLFpathToFileURL

function

pathToFileURLfunction 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:http:///foo/bar.txt"

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

Referenced typesclass URL

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

MDN Reference

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;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

Resources

ReferenceDocsGuidesDiscordMerch StoreGitHubBlog 

Toolkit

RuntimePackage managerTest runnerBundlerPackage runner

Project

Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicense

Baked with ❤️ in San Francisco

We're hiring →