Update doc examples of isInteger, isLength, isNumber, isSafeInteger, toInteger, toLength, toNumber, toSafeInteger, and toString. [ci skip]

This commit is contained in:
John-David Dalton
2015-11-02 13:12:17 -06:00
parent e25369a306
commit 611aaa5385

121
lodash.js
View File

@@ -9327,14 +9327,14 @@
* _.isInteger(3); * _.isInteger(3);
* // => true * // => true
* *
* _.isInteger(Number.MAX_VALUE); * _.isInteger(Number.MIN_VALUE);
* // => true
*
* _.isInteger(3.14);
* // => false * // => false
* *
* _.isInteger(Infinity); * _.isInteger(Infinity);
* // => false * // => false
*
* _.isInteger('3');
* // => false
*/ */
function isInteger(value) { function isInteger(value) {
return typeof value == 'number' && value == toInteger(value); return typeof value == 'number' && value == toInteger(value);
@@ -9355,14 +9355,14 @@
* _.isLength(3); * _.isLength(3);
* // => true * // => true
* *
* _.isLength(Number.MAX_VALUE); * _.isLength(Number.MIN_VALUE);
* // => false
*
* _.isLength(3.14);
* // => false * // => false
* *
* _.isLength(Infinity); * _.isLength(Infinity);
* // => false * // => false
*
* _.isLength('3');
* // => false
*/ */
function isLength(value) { function isLength(value) {
return typeof value == 'number' && value > -1 && value % 1 == 0 && value <= MAX_SAFE_INTEGER; return typeof value == 'number' && value > -1 && value % 1 == 0 && value <= MAX_SAFE_INTEGER;
@@ -9604,13 +9604,16 @@
* @returns {boolean} Returns `true` if `value` is correctly classified, else `false`. * @returns {boolean} Returns `true` if `value` is correctly classified, else `false`.
* @example * @example
* *
* _.isNumber(8.4); * _.isNumber(3);
* // => true * // => true
* *
* _.isNumber(NaN); * _.isNumber(Number.MIN_VALUE);
* // => true * // => true
* *
* _.isNumber('8.4'); * _.isNumber(Infinity);
* // => true
*
* _.isNumber('3');
* // => false * // => false
*/ */
function isNumber(value) { function isNumber(value) {
@@ -9697,14 +9700,14 @@
* _.isSafeInteger(3); * _.isSafeInteger(3);
* // => true * // => true
* *
* _.isSafeInteger(Number.MAX_VALUE); * _.isSafeInteger(Number.MIN_VALUE);
* // => false
*
* _.isSafeInteger(3.14);
* // => false * // => false
* *
* _.isSafeInteger(Infinity); * _.isSafeInteger(Infinity);
* // => false * // => false
*
* _.isSafeInteger('3');
* // => false
*/ */
function isSafeInteger(value) { function isSafeInteger(value) {
return isInteger(value) && value >= -MAX_SAFE_INTEGER && value <= MAX_SAFE_INTEGER; return isInteger(value) && value >= -MAX_SAFE_INTEGER && value <= MAX_SAFE_INTEGER;
@@ -9862,14 +9865,17 @@
* @returns {number} Returns the converted integer. * @returns {number} Returns the converted integer.
* @example * @example
* *
* _.toInteger('3.14'); * _.toInteger(3);
* // => 3 * // => 3
* *
* _.toInteger(NaN); * _.toInteger(Number.MIN_VALUE);
* // => 0 * // => 0
* *
* _.toInteger(-Infinity) * _.toInteger(Infinity);
* // => 1.7976931348623157e+308 * // => 1.7976931348623157e+308
*
* _.toInteger('3');
* // => 3
*/ */
function toInteger(value) { function toInteger(value) {
value = toNumber(value); value = toNumber(value);
@@ -9894,23 +9900,17 @@
* @return {number} Returns the converted integer. * @return {number} Returns the converted integer.
* @example * @example
* *
* _.toLength(NaN); * _.toLength(3);
* // => 3
*
* _.toLength(Number.MIN_VALUE);
* // => 0 * // => 0
* *
* _.toLength(Infinity); * _.toLength(Infinity);
* // => 4294967295 * // => 4294967295
* *
* var answer = { * _.toLength('3');
* valueOf: function () { * // => 3
* return 1;
* },
* toString: function () {
* return 'one';
* }
* };
*
* _.toLength(answer);
* // => 1
*/ */
function toLength(value) { function toLength(value) {
return clamp(toInteger(value), 0, MAX_ARRAY_LENGTH); return clamp(toInteger(value), 0, MAX_ARRAY_LENGTH);
@@ -9924,28 +9924,19 @@
* @category Lang * @category Lang
* @param {*} value The value to process. * @param {*} value The value to process.
* @returns {number} Returns the number. * @returns {number} Returns the number.
* @examples * @example
* *
* _.toNumber(undefined); * _.toNumber(3);
* // => NaN * // => 3
* *
* _.toNumber(null); * _.toNumber(Number.MIN_VALUE);
* // => 0 * // => 5e-324
* *
* _.toNumber('-0'); * _.toNumber(Infinity);
* // => -0 * // => Infinity
* *
* var answer = { * _.toNumber('3');
* valueOf: function() { * // => 3
* return 1;
* },
* toString: function () {
* return 'one';
* }
* };
*
* _.toNumber(answer);
* // => 1
*/ */
function toNumber(value) { function toNumber(value) {
if (isObject(value)) { if (isObject(value)) {
@@ -10000,28 +9991,25 @@
* @returns {number} Returns the converted integer. * @returns {number} Returns the converted integer.
* @example * @example
* *
* _.toSafeInteger('3.14'); * _.toSafeInteger(3);
* // => 3 * // => 3
* *
* _.toSafeInteger(NaN); * _.toSafeInteger(Number.MIN_VALUE);
* // => 0 * // => 0
* *
* _.toSafeInteger(Infinity) * _.toSafeInteger(Infinity);
* // => 9007199254740991 * // => 9007199254740991
* *
* _.toSafeInteger(-Infinity) * _.toSafeInteger('3');
* // => -9007199254740991 * // => 3
*/ */
function toSafeInteger(value) { function toSafeInteger(value) {
return clamp(toInteger(value), -MAX_SAFE_INTEGER, MAX_SAFE_INTEGER); return clamp(toInteger(value), -MAX_SAFE_INTEGER, MAX_SAFE_INTEGER);
} }
/** /**
* Converts `value` to a string if it's not one. * Converts `value` to a string if it's not one. An empty string is returned
* An empty string is returned for `null` and `undefined` values. * for `null` and `undefined` values. The sign of `-0` is preserved.
* The number literals `-0` and `0` preserve their sign to become `'-0'` and `'0'`.
* This method is consistant with `value + ''` coersion rather than casting
* with `String(value)`.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -10036,17 +10024,8 @@
* _.toString(-0); * _.toString(-0);
* // => '-0' * // => '-0'
* *
* var answer = { * _.toString([1, 2, 3]);
* valueOf: function() { * // => '1,2,3'
* return 1;
* },
* toString: function () {
* return 'one';
* }
* };
*
* _.toString(answer);
* // => '1'
*/ */
function toString(value) { function toString(value) {
// Exit early for strings to avoid a performance hit in some environments. // Exit early for strings to avoid a performance hit in some environments.