string/toLocaleLowerCase.js

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