string/padEnd.js

  1. import { convertStringMethod } from './convertStringMethod'
  3. /**
  4.  * Replaces by former string padded at the end with <code>padString</code> to the given <code>length</code>.
  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 {number} targetLength The length to pad to.
  10.  * @param {string} [padString=' '] String to add.
  11.  * @return {Object} Returns the updated object.
  12.  * @example padEnd({ nested: { a: 'Hellow' } }, 10) // => { nested: { a: 'Hellow    ' } }
  13.  * @example padEnd({ nested: { a: 'Hellow' } }, 10, '?!') // => { nested: { a: 'Hellow?!?!' } }
  14.  * @see {@link https://mdn.io/String.prototype.padEnd|String.prototype.padEnd} for more information.
  15.  * @since 1.0.0
  16.  */
  17. const padEnd = convertStringMethod('padEnd')
  19. export { padEnd }