Liking cljdoc? Tell your friends :D

web.url.URL

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

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

constructorcljs

(constructor & args)

Constructor.

The URL() constructor returns a newly created web.url.URL object representing the URL defined by the parameters.

url \tA web.USVString representing an absolute or relative URL. If url is a relative URL, base is required, and will be used as the base URL. If url is an absolute URL, a given base will be ignored. \tbase Optional \tA web.USVString representing the base URL to use in case url is a relative URL. If not specified, it defaults to ''.

Note: You can still use an existing web.url.URL object for the base, which stringifies itself to the object's href attribute.

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/URL

Constructor.

The URL() constructor returns a newly created `web.url.URL` object representing the URL defined by the parameters.

url
\tA `web.USVString` representing an absolute or relative URL. If url is a relative URL, base is required, and will be used as the base URL. If url is an absolute URL, a given base will be ignored.
\tbase Optional
\tA `web.USVString` representing the base URL to use in case url is a relative URL. If not specified, it defaults to ''.



Note: You can still use an existing `web.url.URL` object for the base, which stringifies itself to the object's `href` attribute.

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/URL`
sourceraw docstring

create-object-urlcljs

(create-object-url this object)

Method.

The URL.createObjectURL() static method creates a web.DOMString a URL representing the object given in the parameter. The URL is tied to the document in the window on which it was created. new object URL represents the specified web.files.File object web.files.Blob object.

objectURL = URL.createObjectURL(object);

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL

Method.

The URL.createObjectURL() static method creates a `web.DOMString`
a URL representing the object given in the parameter. The URL
is tied to the `document` in the window on which it was created.
new object URL represents the specified `web.files.File` object
`web.files.Blob` object.

`objectURL = URL.createObjectURL(object);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL`
sourceraw docstring

hashcljs

(hash this)

Property.

The hash property of the web.url.URL interface returns a web.USVString a '#' followed by the fragment identifier of the URL.

string = object.hash; object.hash = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/hash

Property.

The hash property of the `web.url.URL` interface returns a `web.USVString`
a '#' followed by the fragment identifier of the URL.

`string = object.hash;
object.hash = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/hash`
sourceraw docstring

hostcljs

(host this)

Property.

The host property of the web.url.URL interface is a web.USVString the host, that is the hostname, and then, if the port of the is nonempty, a ':', and the port of the URL.

string = object.host; object.host = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/host

Property.

The host property of the `web.url.URL` interface is a `web.USVString`
the host, that is the hostname, and then, if the port of the
is nonempty, a ':', and the port of the URL.

`string = object.host;
object.host = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/host`
sourceraw docstring

hostnamecljs

(hostname this)

Property.

The hostname property of the web.url.URL interface is a web.USVString the domain of the URL.

string = object.hostname; object.hostname = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/hostname

Property.

The hostname property of the `web.url.URL` interface is a `web.USVString`
the domain of the URL.

`string = object.hostname;
object.hostname = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/hostname`
sourceraw docstring

hrefcljs

(href this)

Property.

The href property of the web.url.URL interface is a web.USVString the whole URL.

string = object.href; object.href = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/href

Property.

The href property of the `web.url.URL` interface is a `web.USVString`
the whole URL.

`string = object.href;
object.href = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/href`
sourceraw docstring

origincljs

(origin this)

Property.

[Read Only]

The origin read-only property of the web.url.URL interface a web.USVString containing the Unicode serialization of the of the represented URL. The exact structure varies depending the type of URL:

string = URLObject.origin;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/origin

Property.

[Read Only]

The origin read-only property of the `web.url.URL` interface
a `web.USVString` containing the Unicode serialization of the
of the represented URL. The exact structure varies depending
the type of URL:

`string = URLObject.origin;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/origin`
sourceraw docstring

passwordcljs

(password this)

Property.

The password property of the web.url.URL interface is a web.USVString the password specified before the domain name.

string = object.password; object.password = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/password

Property.

The password property of the `web.url.URL` interface is a `web.USVString`
the password specified before the domain name.

`string = object.password;
object.password = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/password`
sourceraw docstring

pathnamecljs

(pathname this)

Property.

The pathname property of the web.url.URL interface is a web.USVString an initial '/' followed by the path of the URL (or the empty if there is no path).

string = object.pathname; object.pathname = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname

Property.

The pathname property of the `web.url.URL` interface is a `web.USVString`
an initial '/' followed by the path of the URL (or the empty
if there is no path).

`string = object.pathname;
object.pathname = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname`
sourceraw docstring

portcljs

(port this)

Property.

The port property of the web.url.URL interface is a web.USVString the port number of the URL. If the URL does not contain an explicit number, it will be set to ''.

string = object.port; object.port = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/port

Property.

The port property of the `web.url.URL` interface is a `web.USVString`
the port number of the URL. If the URL does not contain an explicit
number, it will be set to ''.

`string = object.port;
object.port = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/port`
sourceraw docstring

protocolcljs

(protocol this)

Property.

The protocol property of the web.url.URL interface is a web.USVString the protocol scheme of the URL, including the final ':'.

string = object.protocol; object.protocol = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/protocol

Property.

The protocol property of the `web.url.URL` interface is a `web.USVString`
the protocol scheme of the URL, including the final ':'.

`string = object.protocol;
object.protocol = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/protocol`
sourceraw docstring

revoke-object-urlcljs

(revoke-object-url this object-url)

Method.

The URL.revokeObjectURL() static method releases an existing URL which was previously created by calling URL.createObjectURL().

window.URL.revokeObjectURL(objectURL);

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/revokeObjectURL

Method.

The URL.revokeObjectURL() static method releases an existing
URL which was previously created by calling `URL.createObjectURL()`.

`window.URL.revokeObjectURL(objectURL);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/revokeObjectURL`
sourceraw docstring

(search this)

Property.

The search property of the web.url.URL interface is a search also called a query string, that is a web.USVString containing '?' followed by the parameters of the URL.

string = object.search; object.search = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/search

Property.

The search property of the `web.url.URL` interface is a search
also called a query string, that is a `web.USVString` containing
'?' followed by the parameters of the URL.

`string = object.search;
object.search = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/search`
sourceraw docstring

search-paramscljs

(search-params this)

Property.

[Read Only]

The searchParams readonly property of the web.url.URL interface a web.url.URLSearchParams object allowing access to the GET query arguments contained in the URL.

var urlSearchParams = URL.searchParams;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams

Property.

[Read Only]

The searchParams readonly property of the `web.url.URL` interface
a `web.url.URLSearchParams` object allowing access to the GET
query arguments contained in the URL.

`var urlSearchParams = URL.searchParams;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams`
sourceraw docstring

set-hash!cljs

(set-hash! this val)

Property.

The hash property of the web.url.URL interface returns a web.USVString a '#' followed by the fragment identifier of the URL.

string = object.hash; object.hash = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/hash

Property.

The hash property of the `web.url.URL` interface returns a `web.USVString`
a '#' followed by the fragment identifier of the URL.

`string = object.hash;
object.hash = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/hash`
sourceraw docstring

set-host!cljs

(set-host! this val)

Property.

The host property of the web.url.URL interface is a web.USVString the host, that is the hostname, and then, if the port of the is nonempty, a ':', and the port of the URL.

string = object.host; object.host = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/host

Property.

The host property of the `web.url.URL` interface is a `web.USVString`
the host, that is the hostname, and then, if the port of the
is nonempty, a ':', and the port of the URL.

`string = object.host;
object.host = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/host`
sourceraw docstring

set-hostname!cljs

(set-hostname! this val)

Property.

The hostname property of the web.url.URL interface is a web.USVString the domain of the URL.

string = object.hostname; object.hostname = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/hostname

Property.

The hostname property of the `web.url.URL` interface is a `web.USVString`
the domain of the URL.

`string = object.hostname;
object.hostname = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/hostname`
sourceraw docstring

set-href!cljs

(set-href! this val)

Property.

The href property of the web.url.URL interface is a web.USVString the whole URL.

string = object.href; object.href = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/href

Property.

The href property of the `web.url.URL` interface is a `web.USVString`
the whole URL.

`string = object.href;
object.href = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/href`
sourceraw docstring

set-password!cljs

(set-password! this val)

Property.

The password property of the web.url.URL interface is a web.USVString the password specified before the domain name.

string = object.password; object.password = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/password

Property.

The password property of the `web.url.URL` interface is a `web.USVString`
the password specified before the domain name.

`string = object.password;
object.password = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/password`
sourceraw docstring

set-pathname!cljs

(set-pathname! this val)

Property.

The pathname property of the web.url.URL interface is a web.USVString an initial '/' followed by the path of the URL (or the empty if there is no path).

string = object.pathname; object.pathname = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname

Property.

The pathname property of the `web.url.URL` interface is a `web.USVString`
an initial '/' followed by the path of the URL (or the empty
if there is no path).

`string = object.pathname;
object.pathname = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname`
sourceraw docstring

set-port!cljs

(set-port! this val)

Property.

The port property of the web.url.URL interface is a web.USVString the port number of the URL. If the URL does not contain an explicit number, it will be set to ''.

string = object.port; object.port = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/port

Property.

The port property of the `web.url.URL` interface is a `web.USVString`
the port number of the URL. If the URL does not contain an explicit
number, it will be set to ''.

`string = object.port;
object.port = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/port`
sourceraw docstring

set-protocol!cljs

(set-protocol! this val)

Property.

The protocol property of the web.url.URL interface is a web.USVString the protocol scheme of the URL, including the final ':'.

string = object.protocol; object.protocol = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/protocol

Property.

The protocol property of the `web.url.URL` interface is a `web.USVString`
the protocol scheme of the URL, including the final ':'.

`string = object.protocol;
object.protocol = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/protocol`
sourceraw docstring

set-search!cljs

(set-search! this val)

Property.

The search property of the web.url.URL interface is a search also called a query string, that is a web.USVString containing '?' followed by the parameters of the URL.

string = object.search; object.search = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/search

Property.

The search property of the `web.url.URL` interface is a search
also called a query string, that is a `web.USVString` containing
'?' followed by the parameters of the URL.

`string = object.search;
object.search = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/search`
sourceraw docstring

set-username!cljs

(set-username! this val)

Property.

The username property of the web.url.URL interface is a web.USVString the username specified before the domain name.

string = object.username; object.username = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/username

Property.

The username property of the `web.url.URL` interface is a `web.USVString`
the username specified before the domain name.

`string = object.username;
object.username = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/username`
sourceraw docstring

to-jsoncljs

(to-json this)

Method.

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

json = url.toJSON();

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/toJSON

Method.

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

`json = url.toJSON();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/toJSON`
sourceraw docstring

to-stringcljs

(to-string this)

Method.

The URL.toString() stringifier method returns a web.USVString the whole URL. It is effectively a read-only version of URL.href.

string = url.toString();

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/toString

Method.

The URL.toString() stringifier method returns a `web.USVString`
the whole URL. It is effectively a read-only version of `URL.href`.

`string = url.toString();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/toString`
sourceraw docstring

usernamecljs

(username this)

Property.

The username property of the web.url.URL interface is a web.USVString the username specified before the domain name.

string = object.username; object.username = string;

See also: https://developer.mozilla.org/en-US/docs/Web/API/URL/username

Property.

The username property of the `web.url.URL` interface is a `web.USVString`
the username specified before the domain name.

`string = object.username;
object.username = string;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/URL/username`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close