NodeJS - urlObject.auth Property

---

---

A URL string is a structured string that contains multiple segments. If we parse this URL string, a URL object is returned. The returned URL Object contains segments that are present in the URL string.

The NodeJS urlObject.auth property of urlObject specifies the auth segment of the URL. It is also referred to as user info. The format of the auth segment in the URL will be {username}[:{password}].

There is no specified rule that the format of the auth segment should be in the same way, the [:{password}] portion is optional.

Syntax

Following is the syntax of the NodeJS urlObject.auth property

urlObject.auth

Parameters

This property does not accept any parameters.

Return Value

This property retrieves the username and password segment of a URL.

Example

If the provided URL contains an auth segment i.e. in {username}[:{password}]format, the auth property will retrieve that segment.

In the following example, we are trying to get the auth segment from the provided URL.

Note: To get the auth segment from the URL by using auth property, we first need to parse the URL using NodeJS url.parse() method; else the auth segment is undefined.

const url = require('url');
let address = 'https://username=Nikhil:password=TutPoint@www.Tutorialspoint.com#foo';
let result = url.parse(address, true);
console.log(result.auth);

Output

As we can see in the output below, the NodeJS auth property retrieved the auth segment from the URL.

username=Nikhil:password=TutPoint

Example

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

We are trying to get the auth segment from the provided URL without parsing.

const url = require('url');
let address = 'https://username=Nikhil:password=TutPoint@www.Tutorialspoint.com#foo';
console.log(address.auth);

Output

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

undefined

Example

The [:{password}] portion in the auth segment is optional.

In the following example, the provided URL contains only the username.

const url = require('url');
let address = 'https://username=Nikhil@www.Tutorialspoint.com#foo';
let result = url.parse(address, true);
console.log(result.auth);

Output

Following is the output of the above code

username=Nikhil

Example

If the provided URL does not include the auth segment, the auth property retrieves null.

const url = require('url');
let address = 'https:www.Tutorialspoint.com';
let result = url.parse(address, true);
console.log(result.auth);

Output

As we can see in the output below, the auth property is null as there is no auth segment involved in the URL.

null