Package-level declarations

Types

sealed external interface FileUrlToPathOptions

sealed external interface PathToFileUrlOptions

sealed external interface Url

sealed external interface URLFormatOptions

sealed external interface UrlObject

sealed external interface UrlWithParsedQuery : Url

sealed external interface UrlWithStringQuery : Url

Returns the Punycode ASCII serialization of the domain. If domain is an invalid domain, the empty string is returned.

Returns the Unicode serialization of the domain. If domain is an invalid domain, the empty string is returned.

external fun fileURLToPath(url: String, options: FileUrlToPathOptions = definedExternally): String

external fun fileURLToPath(url: URL, options: FileUrlToPathOptions = definedExternally): String

This function ensures the correct decodings of percent-encoded characters as well as ensuring a cross-platform valid absolute path string.

external fun format(urlObject: String): String

external fun format(urlObject: UrlObject): String

external fun format(urlObject: URL, options: URLFormatOptions = definedExternally): String

The url.format() method returns a formatted URL string derived from urlObject.

The url.parse() method takes a URL string, parses it, and returns a URL object.

external fun parse(urlString: String, parseQueryString: Boolean, slashesDenoteHost: Boolean = definedExternally): Url

external fun pathToFileURL(path: String, options: PathToFileUrlOptions = definedExternally): URL

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

external fun resolve(from: String, to: String): String

The url.resolve() method resolves a target URL relative to a base URL in a manner similar to that of a web browser resolving an anchor tag.

This utility function converts a URL object into an ordinary options object as expected by the http.request() and https.request() APIs.