From 67701944f1c00362572f16699950b87fa17388d5 Mon Sep 17 00:00:00 2001 From: Xotic750 Date: Mon, 2 Nov 2015 12:15:04 +0100 Subject: [PATCH] Improve `toNumber` documentation by including examples. [ci skip] --- lodash.js | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/lodash.js b/lodash.js index 0f4906978..86c1b2e13 100644 --- a/lodash.js +++ b/lodash.js @@ -9924,6 +9924,28 @@ * @category Lang * @param {*} value The value to process. * @returns {number} Returns the number. + * @examples + * + * _.toNumber(undefined); + * // => NaN + * + * _.toNumber(null); + * // => 0 + * + * _.toNumber('-0'); + * // => -0 + * + * var answer = { + * valueOf: function() { + * return 1; + * }, + * toString: function () { + * return 'one'; + * } + * }; + * + * _.toNumber(answer); + * // => 1 */ function toNumber(value) { if (isObject(value)) {