string/toLocaleLowerCase.js

  1. import { convertStringMethod } from './convertStringMethod'
  3. /**
  4.  * Replaces by former string in lower case.
  5.  * @function
  6.  * @memberof string
  7.  * @param {Object} object The object to modify.
  8.  * @param {Array|string} path The path of the property to set.
  9.  * @param {string?} locale Locale.
  10.  * @return {Object} Returns the updated object.
  11.  * @example toLocaleLowerCase({ nested: { a: 'ÇA vA Bien ?' } }, 'fr_fr') // => { nested: { a: 'ça va bien ?' } }
  12.  * @see {@link https://mdn.io/String.prototype.toLocaleLowerCase|String.prototype.toLocaleLowerCase} for more information.
  13.  * @since 1.0.0
  14.  */
  15. const toLocaleLowerCase = convertStringMethod('toLocaleLowerCase')
  17. export { toLocaleLowerCase }