urlencoded

urlencoded API Reference

Overview

The urlencoded utility provides functions for parsing and formatting URL-encoded strings in Salesforce Commerce Cloud (SFCC). This utility is essential for working with URL-encoded data, such as query parameters and form submissions in web services.

---

Public Methods

parse(urlEncoded: string)

Description: Converts a URL-encoded string into an object where each key-value pair represents a parameter.

• Parameters:
  • urlEncoded (string): The URL-encoded string to be converted.
• Returns:
  • Object.<string, string>: An object containing the parsed key-value pairs.

Usage Example:

var urlencoded = require('*/cartridge/scripts/util/urlencoded');

var queryString = 'param1=value1&param2=value2';
var parsedData = urlencoded.parse(queryString);

console.log(parsedData);
// {
//   param1: 'value1',
//   param2: 'value2'
// }

---

format(data: Object.<string, string>)

Description: Converts an object into a URL-encoded string.

• Parameters:
  • data (Object.<string, string>): The data object to be converted.
• Returns:
  • string: The resulting URL-encoded string.

Usage Example:

var urlencoded = require('*/cartridge/scripts/util/urlencoded');

var data = {
    param1: 'value1',
    param2: 'value2'
};
var queryString = urlencoded.format(data);

console.log(queryString);
// 'param1=value1&param2=value2'

---