kotlin-node/node.url

Package-level declarations

Types

FileUrlToPathOptions

sealed external interface FileUrlToPathOptions

PathToFileUrlOptions

sealed external interface PathToFileUrlOptions

Url

sealed external interface Url

URLFormatOptions

sealed external interface URLFormatOptions

UrlObject

sealed external interface UrlObject

URLPattern

external class URLPattern

URLPatternComponentResult

sealed external interface URLPatternComponentResult

URLPatternInit

sealed external interface URLPatternInit

URLPatternOptions

sealed external interface URLPatternOptions

URLPatternResult

sealed external interface URLPatternResult

UrlWithParsedQuery

sealed external interface UrlWithParsedQuery : Url

UrlWithStringQuery

sealed external interface UrlWithStringQuery : Url

Functions

domainToASCII

external fun domainToASCII(domain: String): String

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

domainToUnicode

external fun domainToUnicode(domain: String): String

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

fileURLToPath

external fun fileURLToPath(url: ERROR CLASS: Symbol not found for URL, options: FileUrlToPathOptions = definedExternally): String

external fun fileURLToPath(url: String, 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.

fileURLToPathBuffer

external fun fileURLToPathBuffer(url: ERROR CLASS: Symbol not found for URL, options: FileUrlToPathOptions = definedExternally): Buffer<*>

external fun fileURLToPathBuffer(url: String, options: FileUrlToPathOptions = definedExternally): Buffer<*>

Like url.fileURLToPath(...) except that instead of returning a string representation of the path, a Buffer is returned. This conversion is helpful when the input URL contains percent-encoded segments that are not valid UTF-8 / Unicode sequences.

format

external fun format(urlObject: String): String

external fun format(urlObject: UrlObject): String

external fun format(urlObject: ERROR CLASS: Symbol not found for URL, options: URLFormatOptions = definedExternally): String

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

parse

external fun parse(urlString: String): UrlWithStringQuery

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

pathToFileURL

external fun pathToFileURL(path: String, options: PathToFileUrlOptions = definedExternally): ERROR CLASS: Symbol not found for URL

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

resolve

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.

urlToHttpOptions

external fun urlToHttpOptions(url: ERROR CLASS: Symbol not found for URL): ClientRequestArgs

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