UNPKG

ramda-adjunct

Version:

Ramda Adjunct is the most popular and most comprehensive set of utilities for use with Ramda, providing a variety of useful, well tested functions with excellent documentation.

29 lines (27 loc) 1.17 kB
import { curryN, split, join, pipe } from 'ramda'; import isRegExp from './isRegExp'; /** * Replaces all substring matches in a string with a replacement. * * @func replaceAll * @memberOf RA * @since {@link https://char0n.github.io/ramda-adjunct/2.17.0|v2.17.0} * @category String * @sig String -> String -> String -> String * @param {string} searchValue The substring to match * @param {string} replaceValue The string to replace the matches with * @param {string} str The String to do the search and replacement in * @return {string} A new string containing all the `searchValue` replaced with the `replaceValue` * @throws {Error} When `searchValue` is RegExp * @see {@link http://ramdajs.com/docs/#replace|R.replace}, {@link https://github.com/tc39/proposal-string-replaceall|TC39 proposal} * @example * * RA.replaceAll('ac', 'ef', 'ac ab ac ab'); //=> 'ef ab ef ab' */ var replaceAll = curryN(3, function (searchValue, replaceValue, str) { if (isRegExp(searchValue)) { throw new Error('searchValue must be a String, not a RegExp.'); } return pipe(split(String(searchValue)), join(String(replaceValue)))(str); }); export default replaceAll;