@ralphschuler.ai function caller.index.<internal>.URL

Interface: URL

index.<internal>.URL

Browser-compatible URL class, implemented by following the WHATWG URL Standard. Examples of parsed URLs may be found in the Standard itself. The URL class is also available on the global object.

In accordance with browser conventions, all properties of URL objects are implemented as getters and setters on the class prototype, rather than as data properties on the object itself. Thus, unlike legacy urlObject s, using the delete keyword on any properties of URL objects (e.g. delete myURL.protocol, delete myURL.pathname, etc) has no effect but will still return true.

Since

v7.0.0, v6.13.0

Hierarchy

• URL

  ↳ URL

Table of contents

Properties

• hash
• host
• hostname
• href
• origin
• password
• pathname
• port
• protocol
• search
• searchParams
• username

Methods

• toJSON
• toString

Properties

hash

• hash: string

Gets and sets the fragment portion of the URL.

const myURL = new URL('https://example.org/foo#bar');
console.log(myURL.hash);
// Prints #bar

myURL.hash = 'baz';
console.log(myURL.href);
// Prints https://example.org/foo#baz

Invalid URL characters included in the value assigned to the hash property are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

Inherited from

URL.hash

Defined in

node_modules/@types/node/url.d.ts:433

---

host

• host: string

Gets and sets the host portion of the URL.

const myURL = new URL('https://example.org:81/foo');
console.log(myURL.host);
// Prints example.org:81

myURL.host = 'example.com:82';
console.log(myURL.href);
// Prints https://example.com:82/foo

Invalid host values assigned to the host property are ignored.

Inherited from

URL.host

Defined in

node_modules/@types/node/url.d.ts:449

---

hostname

• hostname: string

Gets and sets the host name portion of the URL. The key difference betweenurl.host and url.hostname is that url.hostname does not include the port.

const myURL = new URL('https://example.org:81/foo');
console.log(myURL.hostname);
// Prints example.org

// Setting the hostname does not change the port
myURL.hostname = 'example.com';
console.log(myURL.href);
// Prints https://example.com:81/foo

// Use myURL.host to change the hostname and port
myURL.host = 'example.org:82';
console.log(myURL.href);
// Prints https://example.org:82/foo

Invalid host name values assigned to the hostname property are ignored.

Inherited from

URL.hostname

Defined in

node_modules/@types/node/url.d.ts:472

---

href

• href: string

Gets and sets the serialized URL.

const myURL = new URL('https://example.org/foo');
console.log(myURL.href);
// Prints https://example.org/foo

myURL.href = 'https://example.com/bar';
console.log(myURL.href);
// Prints https://example.com/bar

Getting the value of the href property is equivalent to calling toString.

Setting the value of this property to a new value is equivalent to creating a new URL object using new URL(value). Each of the URLobject's properties will be modified.

If the value assigned to the href property is not a valid URL, a TypeErrorwill be thrown.

Inherited from

URL.href

Defined in

node_modules/@types/node/url.d.ts:493

---

origin

• Readonly origin: string

Gets the read-only serialization of the URL's origin.

const myURL = new URL('https://example.org/foo/bar?baz');
console.log(myURL.origin);
// Prints https://example.org

const idnURL = new URL('https://測試');
console.log(idnURL.origin);
// Prints https://xn--g6w251d

console.log(idnURL.hostname);
// Prints xn--g6w251d

Inherited from

URL.origin

Defined in

node_modules/@types/node/url.d.ts:512

---

password

• password: string

Gets and sets the password portion of the URL.

const myURL = new URL('https://abc:[email protected]');
console.log(myURL.password);
// Prints xyz

myURL.password = '123';
console.log(myURL.href);
// Prints https://abc:[email protected]/

Invalid URL characters included in the value assigned to the password property are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

Inherited from

URL.password

Defined in

node_modules/@types/node/url.d.ts:530

---

pathname

• pathname: string

Gets and sets the path portion of the URL.

const myURL = new URL('https://example.org/abc/xyz?123');
console.log(myURL.pathname);
// Prints /abc/xyz

myURL.pathname = '/abcdef';
console.log(myURL.href);
// Prints https://example.org/abcdef?123

Invalid URL characters included in the value assigned to the pathnameproperty are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

Inherited from

URL.pathname

Defined in

node_modules/@types/node/url.d.ts:547

---

port

• port: string

Gets and sets the port portion of the URL.

The port value may be a number or a string containing a number in the range0 to 65535 (inclusive). Setting the value to the default port of theURL objects given protocol will result in the port value becoming the empty string ('').

The port value can be an empty string in which case the port depends on the protocol/scheme:

Upon assigning a value to the port, the value will first be converted to a string using .toString().

If that string is invalid but it begins with a number, the leading number is assigned to port. If the number lies outside the range denoted above, it is ignored.

const myURL = new URL('https://example.org:8888');
console.log(myURL.port);
// Prints 8888

// Default ports are automatically transformed to the empty string
// (HTTPS protocol's default port is 443)
myURL.port = '443';
console.log(myURL.port);
// Prints the empty string
console.log(myURL.href);
// Prints https://example.org/

myURL.port = 1234;
console.log(myURL.port);
// Prints 1234
console.log(myURL.href);
// Prints https://example.org:1234/

// Completely invalid port strings are ignored
myURL.port = 'abcd';
console.log(myURL.port);
// Prints 1234

// Leading numbers are treated as a port number
myURL.port = '5678abcd';
console.log(myURL.port);
// Prints 5678

// Non-integers are truncated
myURL.port = 1234.5678;
console.log(myURL.port);
// Prints 1234

// Out-of-range numbers which are not represented in scientific notation
// will be ignored.
myURL.port = 1e10; // 10000000000, will be range-checked as described below
console.log(myURL.port);
// Prints 1234

Numbers which contain a decimal point, such as floating-point numbers or numbers in scientific notation, are not an exception to this rule. Leading numbers up to the decimal point will be set as the URL's port, assuming they are valid:

myURL.port = 4.567e21;
console.log(myURL.port);
// Prints 4 (because it is the leading number in the string '4.567e21')

Inherited from

URL.port

Defined in

node_modules/@types/node/url.d.ts:620

---

protocol

• protocol: string

Gets and sets the protocol portion of the URL.

const myURL = new URL('https://example.org');
console.log(myURL.protocol);
// Prints https:

myURL.protocol = 'ftp';
console.log(myURL.href);
// Prints ftp://example.org/

Invalid URL protocol values assigned to the protocol property are ignored.

Inherited from

URL.protocol

Defined in

node_modules/@types/node/url.d.ts:636

---

search

• search: string

Gets and sets the serialized query portion of the URL.

const myURL = new URL('https://example.org/abc?123');
console.log(myURL.search);
// Prints ?123

myURL.search = 'abc=xyz';
console.log(myURL.href);
// Prints https://example.org/abc?abc=xyz

Any invalid URL characters appearing in the value assigned the searchproperty will be percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

Inherited from

URL.search

Defined in

node_modules/@types/node/url.d.ts:653

---

searchParams

• Readonly searchParams: URLSearchParams

Gets the URLSearchParams object representing the query parameters of the URL. This property is read-only but the URLSearchParams object it provides can be used to mutate the URL instance; to replace the entirety of query parameters of the URL, use the search setter. See URLSearchParams documentation for details.

Use care when using .searchParams to modify the URL because, per the WHATWG specification, the URLSearchParams object uses different rules to determine which characters to percent-encode. For instance, the URL object will not percent encode the ASCII tilde (~) character, while URLSearchParams will always encode it:

const myURL = new URL('https://example.org/abc?foo=~bar');

console.log(myURL.search);  // prints ?foo=~bar

// Modify the URL via searchParams...
myURL.searchParams.sort();

console.log(myURL.search);  // prints ?foo=%7Ebar

Inherited from

URL.searchParams

Defined in

node_modules/@types/node/url.d.ts:677

---

username

• username: string

Gets and sets the username portion of the URL.

const myURL = new URL('https://abc:[email protected]');
console.log(myURL.username);
// Prints abc

myURL.username = '123';
console.log(myURL.href);
// Prints https://123:[email protected]/

Any invalid URL characters appearing in the value assigned the usernameproperty will be percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

Inherited from

URL.username

Defined in

node_modules/@types/node/url.d.ts:694

Methods

toJSON

▸ toJSON(): string

The toJSON() method on the URL object returns the serialized URL. The value returned is equivalent to that of href and toString.

This method is automatically called when an URL object is serialized with JSON.stringify().

const myURLs = [
  new URL('https://www.example.com'),
  new URL('https://test.example.org'),
];
console.log(JSON.stringify(myURLs));
// Prints ["https://www.example.com/","https://test.example.org/"]

Returns

string

Inherited from

URL.toJSON

Defined in

node_modules/@types/node/url.d.ts:716

---

toString

▸ toString(): string

The toString() method on the URL object returns the serialized URL. The value returned is equivalent to that of href and toJSON.

Returns

string

Inherited from

URL.toString

Defined in

node_modules/@types/node/url.d.ts:699