@schukai/monster/source/types/regex.mjs

Monster is a simple library for creating fast, robust and lightweight websites.

/**
 * Copyright © schukai GmbH and all contributing authors, {{copyRightYear}}. All rights reserved.
 * Node module: @schukai/monster
 *
 * This source code is licensed under the GNU Affero General Public License version 3 (AGPLv3).
 * The full text of the license can be found at: https://www.gnu.org/licenses/agpl-3.0.en.html
 *
 * For those who do not wish to adhere to the AGPLv3, a commercial license is available.
 * Acquiring a commercial license allows you to use this software without complying with the AGPLv3 terms.
 * For more information about purchasing a commercial license, please contact schukai GmbH.
 *
 * SPDX-License-Identifier: AGPL-3.0
 */

import { validateString } from "./validate.mjs";

export { escapeString };

/**
 * This function prefixes all special characters that may appear in a regex with a slash.
 *
 * @param {string} value
 * @return {string}
 * @license AGPLv3
 * @since 1.26.0
 * @copyright schukai GmbH
 * @throws {TypeError} value is not a string
 */
function escapeString(value) {
	return validateString(value)
		.replace(/[|\\{}()[\]^$+*?.]/g, "\\$&")
		.replace(/-/g, "\\x2d");
}