NodeJS - urlObject.search Property

---

---

The NodeJS urlObject.search property of urlObject specifies the complete query string segment of a URL that includes the leading ASCII question mark (?) character. This property does not perform decoding of the query string.

Let’s look into a sample URL below to know where the query string segment is present.

The URL is “https://user:pass@example.com:80000/pa/th?q=val#hash”.

• “?q=val” is the query string segment.

Syntax

Following is the syntax of the NodeJS urlObject.search property

urlObject.search

Parameters

This property does not accept any parameters.

Return Value

This property retrieves the entire query string segment of a URL.

Example

If the query string segment is present in the provided URL, the NodeJS urlObject.search property will return that segment.

In the following example, we are trying to get the query string segment from the given URL.

const url = require('url');
let address = 'https://user:pass@site.com:80000/pa/th?q=val#hash';
let result = url.parse(address, true);
console.log(result.search);

Output

Following is the output of the above code

?q=val

Example

If the provided URL does not contain the query string segment, the search property returns null.

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

Output

As we can see in the output below, the search property returned null because the given URL does not contain a query string segment.

null