NodeJS - urlObject.href Property

---

---

The NodeJS urlObject.href property of urlObject specifies the full lower-case URL string that is parsed with both protocol and host segments. If the URL string contains upper-case letters, the href property converts them to lower-case.

For instance, consider an URL “https://user:pass@SITE.com/pa/th?=val#hash”, the returned value of the hash property will be “https://user:pass@Site.com/pa/th?=val#hash”.

Syntax

Following is the syntax of the NodeJS urlObject.href property

urlObject.href

Parameters

This property does not accept any parameters.

Return Value

This property retrieves the complete URL string that was parsed including protocol and host segments converted to lowercase.

Example

The following example demonstrates the usage of the NodeJS urlObject.href property.

const url = require('url');
let address = 'https://user:pass@tutorialspoint.com/pa/th?=val#hashh';
let result = url.parse(address, true);
console.log(result.href);

Output

As we can see in the output below, the NodeJS href property retrieved the complete URL string including protocol and host segments.

https://user:pass@tutorialspoint.com/pa/th?=val#hashh

Example

If we do not parse the specified URL, the auth property will be undefined.

We are trying to get the complete URL string using the href property without parsing.

const url = require('url');
let address = 'https://user:pass@tutorialspoint.com/pa/th?=val#hashh';
console.log(address.href);

Output

As we can see in the output below, the href property is undefined.

undefined