URL

open class URL(url: String, base: String = definedExternally)(source)

The URL interface is used to parse, construct, normalize, and encode URLs. It works by providing properties which allow you to easily read and modify the components of a URL.

MDN Reference

Constructors

URL

constructor(url: String, base: String = definedExternally)

constructor(url: URL, base: String = definedExternally)

constructor(url: String, base: URL)

constructor(url: URL, base: URL)

Types

Companion

object Companion

Properties

hash

var hash: String

The hash property of the URL interface is a string containing a "#" followed by the fragment identifier of the URL. If the URL does not have a fragment identifier, this property contains an empty string, "".

host

var host: String

The host property of the URL interface is a string containing the host, which is the hostname, and then, if the port of the URL is nonempty, a ":", followed by the port of the URL. If the URL does not have a hostname, this property contains an empty string, "".

hostname

var hostname: String

The hostname property of the URL interface is a string containing either the domain name or IP address of the URL. If the URL does not have a hostname, this property contains an empty string, "". IPv4 and IPv6 addresses are normalized, such as stripping leading zeros, and domain names are converted to IDN.

href

var href: String

The href property of the URL interface is a string containing the whole URL.

origin

val origin: String

The origin read-only property of the URL interface returns a string containing the Unicode serialization of the origin of the represented URL.

password

var password: String

The password property of the URL interface is a string containing the password component of the URL. If the URL does not have a password, this property contains an empty string, "".

pathname

var pathname: String

The pathname property of the URL interface represents a location in a hierarchical structure. It is a string constructed from a list of path segments, each of which is prefixed by a / character.

port

var port: String

The port property of the URL interface is a string containing the port number of the URL. If the port is the default for the protocol (80 for ws: and http:, 443 for wss: and https:, and 21 for ftp:), this property contains an empty string, "".

protocol

var protocol: String

The protocol property of the URL interface is a string containing the protocol or scheme of the URL, including the final ":".

var search: String

The search property of the URL interface is a search string, also called a query string, that is a string containing a "?" followed by the parameters of the URL. If the URL does not have a search query, this property contains an empty string, "".

searchParams

val searchParams: URLSearchParams

The searchParams read-only property of the URL interface returns a URLSearchParams object allowing access to the GET decoded query arguments contained in the URL.

username

var username: String

The username property of the URL interface is a string containing the username component of the URL. If the URL does not have a username, this property contains an empty string, "".

Functions

toJSON

fun toJSON(): String

The toJSON() method of the URL interface returns a string containing a serialized version of the URL, although in practice it seems to have the same effect as URL.toString().