Node.js Query String

Last Updated : 12 Aug, 2024

The Query String module used to provides utilities for parsing and formatting URL query strings. It can be used to convert query string into JSON object and vice-versa.

Node.js Query String

Query strings in Node.js are a common way to pass data to a server via a URL. A query string is the part of a URL that comes after a "?" symbol and contains key-value pairs separated by &. These strings are used in HTTP requests to send additional parameters to the server.

The Query String is the part of the URL that starts after the question mark(?).

Importing Module:

You can include the module using the following code:

const querystring = require('querystring');

Note: It’s not a global object, so need to install it explicitly.

Install Module:

npm install querystring

Example 1: Using parse()

JavaScript

// Filename - index.js  // Importing the models import url from 'url' import querystring from 'querystring'  // A URL is taken let exampleUrl =  'http://www.company.com:81/a/b/c.html?user=GEEKSFORGEEKS&year=2021#p2';  //Parse the whole URL let parsed_Url = url.parse(exampleUrl);  // Parse only querystring. let parsed_queryString = querystring.parse(parsed_Url.query);  // Print the result. console.log("This is parsed URL :",parsed_Url);  console.log("This is parsed Query String :",parsed_queryString);

Output:

This is parsed URL : Url {
  protocol: 'http:',
  slashes: true,
  auth: null,
  host: 'www.company.com:81',
  port: '81',
  hostname: 'www.company.com',
  hash: '#p2',
  search: '?user=GEEKSFORGEEKS&year=2021',
  query: 'user=GEEKSFORGEEKS&year=2021',
  pathname: '/a/b/c.html',
  path: '/a/b/c.html?user=GEEKSFORGEEKS&year=2021',
  href: 
'http://www.company.com:81/a/b/c.html?user=GEEKSFORGEEKS&year=2021#p2'
}
This is parsed Query String : [Object: null prototype] 
               { user: 'GEEKSFORGEEKS', year: '2021' }

Example 2: Using stringify():

JavaScript

// Importing the model import querystring from 'querystring'  // Specify the  object  // to be serialized  const q2=querystring.stringify({                             name:'Testing',                             company:'GeeksforGeeks',                             content:'Article',                             date:'9thMarch2021'                            });    // Print the result. console.log(q2);

Output:

name=Testing&company=GeeksforGeeks&
content=Article&date=9thMarch2021

Benefits

Query strings provide a simple way to pass small amounts of data to the server without needing to modify the URL or body of the request.
Query strings allow search engines to index pages with specific parameters, improving SEO.
Query strings are often used in combination with HTML forms, where form data is submitted via the URL.

Summary

The querystring module is essential for managing query strings in Node.js applications. It provides straightforward methods for parsing and formatting query strings, making it easier to handle URL parameters in web development.

Reference: https://nodejs.org/api/querystring.html