blob: 22cd38a5b2a166fdbbed66ffc5223ba5d01af2e2 [file] [log] [blame]
var baseToString = require('../internal/baseToString'),
charsLeftIndex = require('../internal/charsLeftIndex'),
charsRightIndex = require('../internal/charsRightIndex'),
isIterateeCall = require('../internal/isIterateeCall'),
trimmedLeftIndex = require('../internal/trimmedLeftIndex'),
trimmedRightIndex = require('../internal/trimmedRightIndex');
/**
* Removes leading and trailing whitespace or specified characters from `string`.
*
* @static
* @memberOf _
* @category String
* @param {string} [string=''] The string to trim.
* @param {string} [chars=whitespace] The characters to trim.
* @param- {Object} [guard] Enables use as a callback for functions like `_.map`.
* @returns {string} Returns the trimmed string.
* @example
*
* _.trim(' abc ');
* // => 'abc'
*
* _.trim('-_-abc-_-', '_-');
* // => 'abc'
*
* _.map([' foo ', ' bar '], _.trim);
* // => ['foo', 'bar']
*/
function trim(string, chars, guard) {
var value = string;
string = baseToString(string);
if (!string) {
return string;
}
if (guard ? isIterateeCall(value, chars, guard) : chars == null) {
return string.slice(trimmedLeftIndex(string), trimmedRightIndex(string) + 1);
}
chars = (chars + '');
return string.slice(charsLeftIndex(string, chars), charsRightIndex(string, chars) + 1);
}
module.exports = trim;