NodeJS - urlObject.port 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.port property of urlObject specifies the numeric port portion of the host segment from a URL.

For instance, consider the URL “https://user:pass@site.com:8000/pa/th#hashh”.

• “site.com:8000” is the host segment.

• “8000” is the port portion.

Syntax

Following is the syntax of the NodeJS urlObject.port property

urlObject.port

Parameters

This property does not accept any parameters.

Return Value

This property retrieves the numeric port portion of the host segment from a URL.

Example

If the provided URL contains a port portion in the host segment, the NodeJS urlObject.port property will retrieve only the port portion.

In the following example, we are trying to get the port portion from the provided URL.

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

Output

As we can see in the output below, the NodeJs port property retrieved the port portion from the URL.

8000

Example

If the provided URL does not contain a port portion in the host segment, the port property will return null.

In the following example, we are proving a URL without a port parameter in it.

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

Output

Following is the output of the above code

null

Example

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

We are trying to get the port portion in the host segment from the URL using the port property without parsing.

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

Output

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

undefined