lodash/lodash

Find file

b679e9c

Mar 31, 2017

merriam Update _.pad* examples to show pad length < string. (#3088 )

Raw Blame History

33 lines (30 sloc) 866 Bytes

      
        import createPadding from './.internal/createPadding.js'
      
        import stringSize from './.internal/stringSize.js'
      
        /**
      
         * Pads `string` on the left side if it's shorter than `length`. Padding
      
         * characters are truncated if they exceed `length`.
      
         *
      
         * @since 4.0.0
      
         * @category String
      
         * @param {string} [string=''] The string to pad.
      
         * @param {number} [length=0] The padding length.
      
         * @param {string} [chars=' '] The string used as padding.
      
         * @returns {string} Returns the padded string.
      
         * @example
      
         *
      
         * padStart('abc', 6)
      
         * // => '   abc'
      
         *
      
         * padStart('abc', 6, '_-')
      
         * // => '_-_abc'
      
         *
      
         * padStart('abc', 2)
      
         * // => 'abc'
      
         */
      
        function padStart(string, length, chars) {
      
          const strLength = length ? stringSize(string) : 0
      
          return (length && strLength < length)
      
            ? (createPadding(length - strLength, chars) + string)
      
            : string
      
        }
      
        export default padStart

May	JUN	Jul
	26
2016	2017	2018

lodash/lodash

Users who have contributed to this file