string/trim.js

  1. import { convertStringMethod } from './convertStringMethod'
  3. /**
  4.  * Replaces by former string stripped of whitespaces at start and end.
  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.  * @return {Object} Returns the updated object.
  10.  * @example trim({ nested: { a: '   Hello world !   ' } }) // => { nested: { a: 'Hello world !' } }
  11.  * @see {@link https://mdn.io/String.prototype.trim|String.prototype.trim} for more information.
  12.  * @since 1.0.0
  13.  */
  14. const trim = convertStringMethod('trim')
  16. export { trim }