foop/src/deps/fp/replace.js

interfaces that describe their intentions.

const curry = require('./curry')

/**
 * Replace a substring or regex match in a string with a replacement.
 *
 * @func
 * @memberOf fp
 * @since v5.0.0
 * @category String
 * @sig RegExp|String -> String -> String -> String
 *
 * @param {RegExp|String} pattern A regular expression or a substring to match.
 * @param {String} replacement The string to replace the matches with.
 * @param {String} str The String to do the search and replacement in.
 * @return {String} The result.
 *
 * @types fp
 * @tests fp/replace
 *
 * {@link https://github.com/ramda/ramda/blob/master/src/replace.js ramda-replace}
 * {@link https://github.com/lodash/lodash/blob/master/replace.js lodash-replace}
 * @see {@link ramda-replace}
 * @see {@link lodash-replace}
 *
 * @example
 *
 *      replace('foo', 'bar', 'foo foo foo'); //=> 'bar foo foo'
 *      replace(/foo/, 'bar', 'foo foo foo'); //=> 'bar foo foo'
 *
 *      // Use the "g" (global) flag to replace all occurrences:
 *      replace(/foo/g, 'bar', 'foo foo foo'); //=> 'bar bar bar'
 *
 */
module.exports = curry(3, function replace(pattern, replacement, str) {
  return str.replace(pattern, replacement)
})