string/slice.js

  1. import { convertStringMethod } from './convertStringMethod'
  3. /**
  4.  * Replaces by a slice of former string starting at <code>beginIndex</code> and ending at <code>endIndex</code> or end of the string.<br/>
  5.  * ⚠ Due to name conflicts, this function is named <code>stringSlice</code> when imported from top level (<code>import { stringSlice } from 'immutadot'</code>).
  6.  * @function
  7.  * @memberof string
  8.  * @param {Object} object The object to modify.
  9.  * @param {Array|string} path The path of the property to set.
  10.  * @param {number} beginIndex Beginning index of slice.
  11.  * @param {number?} endIndex Ending index of slice.
  12.  * @return {Object} Returns the updated object.
  13.  * @example slice({ nested: { a: 'Hello World !' } }, 6) // => { nested: { a: 'World !' } }
  14.  * @example slice({ nested: { a: 'Hello World !' } }, 6, 11) // => { nested: { a: 'World' } }
  15.  * @see {@link https://mdn.io/String.prototype.slice|String.prototype.slice} for more information.
  16.  * @since 1.0.0
  17.  */
  18. const slice = convertStringMethod('slice')
  20. export { slice }