@ou-imdt/utils/lib/getUrlParam.js

Utility library for interactive media development

/**
 * Retrieves a single URL parameter value from the current window's URL.
 * Boolean strings ("true" or "false") are converted to their respective boolean values.
 *
 * @param {string} paramName - The name of the URL parameter to retrieve.
 * @returns {string|boolean|null} The value of the URL parameter. Boolean strings are parsed to boolean values. Returns null if the parameter does not exist.
 */
export default function getUrlParam(paramName) {
  const url = new URL(window.location);
  const urlParams = new URLSearchParams(url.search);
  let paramValue = urlParams.get(paramName);

  if (paramValue === 'true' || paramValue === 'false') {
    paramValue = JSON.parse(paramValue);
  }

  return paramValue;
}