Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-10 10:57:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add doc examples for isXyz methods. [ci skip]

Browse Source
This commit is contained in:
John-David Dalton
2014-03-12 00:30:36 -07:00
parent a40748e3aa
commit a4c15e5fa5
1 changed files with 46 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
lodash.js
View File

@@ -6046,7 +6046,7 @@
* @returns {boolean} Returns `true` if the `value` is an `arguments` object, else `false`. * @returns {boolean} Returns `true` if the `value` is an `arguments` object, else `false`.
* @example * @example
* *
* (function() { return _.isArguments(arguments); })(1, 2, 3); * (function() { return _.isArguments(arguments); })();
* // => true * // => true
* *
* _.isArguments([1, 2, 3]); * _.isArguments([1, 2, 3]);
@@ -6075,11 +6075,11 @@
* @returns {boolean} Returns `true` if the `value` is an array, else `false`. * @returns {boolean} Returns `true` if the `value` is an array, else `false`.
* @example * @example
* *
* (function() { return _.isArray(arguments); })();
* // => false
*
* _.isArray([1, 2, 3]); * _.isArray([1, 2, 3]);
* // => true * // => true
*
* (function() { return _.isArray(arguments); })();
* // => false
*/ */
var isArray = nativeIsArray || function(value) { var isArray = nativeIsArray || function(value) {
return value && typeof value == 'object' && typeof value.length == 'number' && return value && typeof value == 'object' && typeof value.length == 'number' &&
@@ -6096,6 +6096,9 @@
* @returns {boolean} Returns `true` if the `value` is a boolean value, else `false`. * @returns {boolean} Returns `true` if the `value` is a boolean value, else `false`.
* @example * @example
* *
* _.isBoolean(false);
* // => true
*
* _.isBoolean(null); * _.isBoolean(null);
* // => false * // => false
*/ */
@@ -6116,6 +6119,9 @@
* *
* _.isDate(new Date); * _.isDate(new Date);
* // => true * // => true
*
* _.isDate('Wed May 23 2012');
* // => false
*/ */
function isDate(value) { function isDate(value) {
return value && typeof value == 'object' && toString.call(value) == dateClass || false; return value && typeof value == 'object' && toString.call(value) == dateClass || false;
@@ -6133,6 +6139,9 @@
* *
* _.isElement(document.body); * _.isElement(document.body);
* // => true * // => true
*
* _.isElement('<body>');
* // => false
*/ */
function isElement(value) { function isElement(value) {
return value && typeof value == 'object' && value.nodeType === 1 && return value && typeof value == 'object' && value.nodeType === 1 &&
@@ -6158,14 +6167,20 @@
* @returns {boolean} Returns `true` if the `value` is empty, else `false`. * @returns {boolean} Returns `true` if the `value` is empty, else `false`.
* @example * @example
* *
* _.isEmpty(null);
* // => true
*
* _.isEmpty(true);
* // => true
*
* _.isEmpty(1);
* // => true
*
* _.isEmpty([1, 2, 3]); * _.isEmpty([1, 2, 3]);
* // => false * // => false
* *
* _.isEmpty({}); * _.isEmpty({ 'a': 1 });
* // => true * // => false
*
* _.isEmpty('');
* // => true
*/ */
function isEmpty(value) { function isEmpty(value) {
var result = true; var result = true;
@@ -6290,6 +6305,9 @@
* *
* _.isFunction(_); * _.isFunction(_);
* // => true * // => true
*
* _.isFunction(/abc/);
* // => false
*/ */
function isFunction(value) { function isFunction(value) {
return typeof value == 'function'; return typeof value == 'function';
@@ -6375,7 +6393,7 @@
* _.isNull(null); * _.isNull(null);
* // => true * // => true
* *
* _.isNull(undefined); * _.isNull(void 0);
* // => false * // => false
*/ */
function isNull(value) { function isNull(value) {
@@ -6395,8 +6413,14 @@
* @returns {boolean} Returns `true` if the `value` is a number, else `false`. * @returns {boolean} Returns `true` if the `value` is a number, else `false`.
* @example * @example
* *
* _.isNumber(8.4 * 5); * _.isNumber(8.4);
* // => true * // => true
*
* _.isNumber(NaN);
* // => true
*
* _.isNumber('8.4');
* // => false
*/ */
function isNumber(value) { function isNumber(value) {
var type = typeof value; var type = typeof value;
@@ -6450,8 +6474,11 @@
* @returns {boolean} Returns `true` if the `value` is a regular expression, else `false`. * @returns {boolean} Returns `true` if the `value` is a regular expression, else `false`.
* @example * @example
* *
* _.isRegExp(/fred/); * _.isRegExp(/abc/);
* // => true * // => true
*
* _.isRegExp('/abc/');
* // => false
*/ */
function isRegExp(value) { function isRegExp(value) {
var type = typeof value; var type = typeof value;
@@ -6469,8 +6496,11 @@
* @returns {boolean} Returns `true` if the `value` is a string, else `false`. * @returns {boolean} Returns `true` if the `value` is a string, else `false`.
* @example * @example
* *
* _.isString('fred'); * _.isString('abc');
* // => true * // => true
*
* _.isString(1);
* // => false
*/ */
function isString(value) { function isString(value) {
return typeof value == 'string' || return typeof value == 'string' ||
@@ -6489,6 +6519,9 @@
* *
* _.isUndefined(void 0); * _.isUndefined(void 0);
* // => true * // => true
*
* _.isUndefined(null);
* // => false
*/ */
function isUndefined(value) { function isUndefined(value) {
return typeof value == 'undefined'; return typeof value == 'undefined';