trim.js 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. var baseToString = require('../internal/baseToString'),
  2. charsLeftIndex = require('../internal/charsLeftIndex'),
  3. charsRightIndex = require('../internal/charsRightIndex'),
  4. isIterateeCall = require('../internal/isIterateeCall'),
  5. trimmedLeftIndex = require('../internal/trimmedLeftIndex'),
  6. trimmedRightIndex = require('../internal/trimmedRightIndex');
  7. /**
  8. * Removes leading and trailing whitespace or specified characters from `string`.
  9. *
  10. * @static
  11. * @memberOf _
  12. * @category String
  13. * @param {string} [string=''] The string to trim.
  14. * @param {string} [chars=whitespace] The characters to trim.
  15. * @param- {Object} [guard] Enables use as a callback for functions like `_.map`.
  16. * @returns {string} Returns the trimmed string.
  17. * @example
  18. *
  19. * _.trim(' abc ');
  20. * // => 'abc'
  21. *
  22. * _.trim('-_-abc-_-', '_-');
  23. * // => 'abc'
  24. *
  25. * _.map([' foo ', ' bar '], _.trim);
  26. * // => ['foo', 'bar']
  27. */
  28. function trim(string, chars, guard) {
  29. var value = string;
  30. string = baseToString(string);
  31. if (!string) {
  32. return string;
  33. }
  34. if (guard ? isIterateeCall(value, chars, guard) : chars == null) {
  35. return string.slice(trimmedLeftIndex(string), trimmedRightIndex(string) + 1);
  36. }
  37. chars = (chars + '');
  38. return string.slice(charsLeftIndex(string, chars), charsRightIndex(string, chars) + 1);
  39. }
  40. module.exports = trim;