Node.js urlObject.query API

Last Updated : 31 Mar, 2023

The urlObject.query is the query string returned without the ASCII question mark (?) or an object returned by the query string module named as parse() method. The url.parse() method is used to check whether the query is a string or an object. Basically, the argument (parseQueryString) that is passed to url.parse() method to tell the nature of the query.

Syntax

urlObject.query

Note: If this method returns as a string then the decoding of the query string is not performed and if it returns an object then both key and value pairs are decoded.

'query=string' or {'query': 'object'}

'http://localhost:8000/gfg.html?name:GFG'
In the above URL, the name is the query and GFG is the string.

Example 1: The below programs illustrate the use of url.query method in Node.js:

javascript

// Node program to demonstrate the  
// url.query API as Setter
 
// Importing the module 'url'
const url = require('url');

// Set the URL from which the queryString will be fetched
const address = 'http://localhost:8000/gfg.html?month=December'; 

// Parse the address
const q = url.parse(address, true);
 
// The query property returns an object with all the
// querystring parameters as properties
let query = q.query;

let month = query.month;
 
console.log(month);

Output:

December

Example 2: In the example, we will see the use of url.query method

javascript

// Node program to demonstrate the  
// url.query API as Setter

// Importing the module 'url'
const url = require('url');

// Set the URL from which the queryString will be fetched
const address = 'http://localhost:8000/gfg.html?month=December&year=2019';

// Parse the address
const q = url.parse(address, true);

// The query property returns an object with all the
// querystring parameters as properties
let query = q.query;

let year = query.year;

console.log(year);