padLeft.js 654 B

123456789101112131415161718192021222324252627
  1. var createPadDir = require('../internal/createPadDir');
  2. /**
  3. * Pads `string` on the left side if it's shorter than `length`. Padding
  4. * characters are truncated if they exceed `length`.
  5. *
  6. * @static
  7. * @memberOf _
  8. * @category String
  9. * @param {string} [string=''] The string to pad.
  10. * @param {number} [length=0] The padding length.
  11. * @param {string} [chars=' '] The string used as padding.
  12. * @returns {string} Returns the padded string.
  13. * @example
  14. *
  15. * _.padLeft('abc', 6);
  16. * // => ' abc'
  17. *
  18. * _.padLeft('abc', 6, '_-');
  19. * // => '_-_abc'
  20. *
  21. * _.padLeft('abc', 3);
  22. * // => 'abc'
  23. */
  24. var padLeft = createPadDir();
  25. module.exports = padLeft;