You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/repl/help/lib/db.js
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1129,12 +1129,13 @@ var db = {
1129
1129
"isSafeIntegerArray": "\nisSafeIntegerArray( value )\n Tests if a value is an array-like object containing only safe integers.\n\n An integer valued number is \"safe\" when the number can be exactly\n represented as a double-precision floating-point number.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is an array-like object containing\n only safe integers.\n\n Examples\n --------\n > var arr = [ -3.0, new Number(0.0), 2.0 ];\n > var bool = isSafeIntegerArray( arr )\n true\n > arr = [ -3.0, '3.0' ];\n > bool = isSafeIntegerArray( arr )\n false\n\n\nisSafeIntegerArray.primitives( value )\n Tests if a value is an array-like object containing only primitive safe\n integer values.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is an array-like object containing only\n primitive safe integer values.\n\n Examples\n --------\n > var arr = [ -1.0, 10.0 ];\n > var bool = isSafeIntegerArray.primitives( arr )\n true\n > arr = [ -1.0, 0.0, 5.0 ];\n > bool = isSafeIntegerArray.primitives( arr )\n true\n > arr = [ -3.0, new Number(-1.0) ];\n > bool = isSafeIntegerArray.primitives( arr )\n false\n\n\nisSafeIntegerArray.objects( value )\n Tests if a value is an array-like object containing only `Number` objects\n having safe integer values.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is an array-like object containing only\n `Number` objects having safe integer values.\n\n Examples\n --------\n > var arr = [ new Number(1.0), new Number(3.0) ];\n > var bool = isSafeIntegerArray.objects( arr )\n true\n > arr = [ -1.0, 0.0, 3.0 ];\n > bool = isSafeIntegerArray.objects( arr )\n false\n > arr = [ 3.0, new Number(-1.0) ];\n > bool = isSafeIntegerArray.objects( arr )\n false\n\n See Also\n --------\n isArray, isSafeInteger\n",
1130
1130
"isSameValue": "\nisSameValue( a, b )\n Tests if two arguments are the same value.\n\n The function differs from the `===` operator in that the function treats\n `-0` and `+0` as distinct and `NaNs` as the same.\n\n Parameters\n ----------\n a: any\n First input value.\n\n b: any\n Second input value.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether two arguments are the same value.\n\n Examples\n --------\n > var bool = isSameValue( true, true )\n true\n > bool = isSameValue( {}, {} )\n false\n > bool = isSameValue( -0.0, -0.0 )\n true\n > bool = isSameValue( -0.0, 0.0 )\n false\n > bool = isSameValue( NaN, NaN )\n true\n\n See Also\n --------\n isStrictEqual\n",
1131
1131
"isSharedArrayBuffer": "\nisSharedArrayBuffer( value )\n Tests if a value is a SharedArrayBuffer.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a SharedArrayBuffer.\n\n Examples\n --------\n // Assuming an environment supports SharedArrayBuffer...\n > var bool = isSharedArrayBuffer( new SharedArrayBuffer( 10 ) )\n true\n > bool = isSharedArrayBuffer( [] )\n false\n\n See Also\n --------\n isArrayBuffer, isTypedArray\n",
1132
-
"isSquareMatrix": "\nisSquareMatrix( value )\n Tests if a value is a 2-dimensional ndarray-like object having equal\n dimensions.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 2-dimensional ndarray-like\n object having equal dimensions.\n\n Examples\n --------\n > var M = {};\n > M.data = [ 0, 0, 0, 0 ];\n > M.ndims = 2;\n > M.shape = [ 2, 2 ];\n > M.strides = [ 2, 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'generic';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isSquareMatrix( M )\n true\n > bool = isSquareMatrix( [ 1, 2, 3, 4 ] )\n false\n > bool = isSquareMatrix( 3.14 )\n false\n > bool = isSquareMatrix( {} )\n false\n\n See Also\n --------\n isMatrixLike\n",
1132
+
"isSquareMatrix": "\nisSquareMatrix( value )\n Tests if a value is a 2-dimensional ndarray-like object having equal\n dimensions.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 2-dimensional ndarray-like\n object having equal dimensions.\n\n Examples\n --------\n > var M = {};\n > M.data = [ 0, 0, 0, 0 ];\n > M.ndims = 2;\n > M.shape = [ 2, 2 ];\n > M.strides = [ 2, 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'generic';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isSquareMatrix( M )\n true\n > bool = isSquareMatrix( [ 1, 2, 3, 4 ] )\n false\n > bool = isSquareMatrix( 3.14 )\n false\n > bool = isSquareMatrix( {} )\n false\n\n See Also\n --------\n isMatrixLike, isSymmetricMatrix\n",
1133
1133
"isStrictEqual": "\nisStrictEqual( a, b )\n Tests if two arguments are strictly equal.\n\n The function differs from the `===` operator in that the function treats\n `-0` and `+0` as distinct.\n\n Parameters\n ----------\n a: any\n First input value.\n\n b: any\n Second input value.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether two arguments are strictly equal.\n\n Examples\n --------\n > var bool = isStrictEqual( true, true )\n true\n > bool = isStrictEqual( {}, {} )\n false\n > bool = isStrictEqual( -0.0, -0.0 )\n true\n > bool = isStrictEqual( -0.0, 0.0 )\n false\n > bool = isStrictEqual( NaN, NaN )\n false\n\n See Also\n --------\n isSameValue\n",
1134
1134
"isString": "\nisString( value )\n Tests if a value is a string.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a string.\n\n Examples\n --------\n > var bool = isString( 'beep' )\n true\n > bool = isString( new String( 'beep' ) )\n true\n > bool = isString( 5 )\n false\n\n\nisString.isPrimitive( value )\n Tests if a value is a string primitive.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a string primitive.\n\n Examples\n --------\n > var bool = isString.isPrimitive( 'beep' )\n true\n > bool = isString.isPrimitive( new String( 'beep' ) )\n false\n\n\nisString.isObject( value )\n Tests if a value is a `String` object.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a `String` object.\n\n Examples\n --------\n > var bool = isString.isObject( new String( 'beep' ) )\n true\n > bool = isString.isObject( 'beep' )\n false\n\n",
1135
1135
"isStringArray": "\nisStringArray( value )\n Tests if a value is an array of strings.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is an array of strings.\n\n Examples\n --------\n > var bool = isStringArray( [ 'abc', 'def' ] )\n true\n > bool = isStringArray( [ 'abc', 123 ] )\n false\n\n\nisStringArray.primitives( value )\n Tests if a value is an array containing only string primitives.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is an array containing only string\n primitives.\n\n Examples\n --------\n > var arr = [ 'abc', 'def' ];\n > var bool = isStringArray.primitives( arr )\n true\n > arr = [ 'abc', new String( 'def' ) ];\n > bool = isStringArray.primitives( arr )\n false\n\n\nisStringArray.objects( value )\n Tests if a value is an array containing only `String` objects.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is an array containing only `String`\n objects.\n\n Examples\n --------\n > var arr = [ new String( 'ab' ), new String( 'cd' ) ];\n > var bool = isStringArray.objects( arr )\n true\n > arr = [ new String( 'abc' ), 'def' ];\n > bool = isStringArray.objects( arr )\n false\n\n See Also\n --------\n isArray, isString\n",
1136
1136
"isSymbol": "\nisSymbol( value )\n Tests if a value is a symbol.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a symbol.\n\n Examples\n --------\n > var bool = isSymbol( Symbol( 'beep' ) )\n true\n > bool = isSymbol( Object( Symbol( 'beep' ) ) )\n true\n > bool = isSymbol( {} )\n false\n > bool = isSymbol( null )\n false\n > bool = isSymbol( true )\n false\n\n",
1137
1137
"isSymbolArray": "\nisSymbolArray( value )\n Tests if a value is an array-like object containing only symbols.\n\n In pre-ES2015 environments, the function always returns `false`.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is an array-like object containing\n only symbols.\n\n Examples\n --------\n > var bool = isSymbolArray( [ Symbol( 'beep' ), Symbol( 'boop' ) ] )\n true\n > bool = isSymbolArray( Symbol( 'beep' ) )\n false\n > bool = isSymbolArray( [] )\n false\n > bool = isSymbolArray( {} )\n false\n > bool = isSymbolArray( null )\n false\n > bool = isSymbolArray( true )\n false\n\n\nisSymbolArray.primitives( value )\n Tests if a value is an array-like object containing only `symbol`\n primitives.\n\n In pre-ES2015 environments, the function always returns `false`.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is an array-like object containing\n only `symbol` primitives.\n\n Examples\n --------\n > var bool = isSymbolArray.primitives( [ Symbol( 'beep' ) ] )\n true\n > bool = isSymbolArray.primitives( [ Object( Symbol( 'beep' ) ) ] )\n false\n > bool = isSymbolArray.primitives( [] )\n false\n > bool = isSymbolArray.primitives( {} )\n false\n > bool = isSymbolArray.primitives( null )\n false\n > bool = isSymbolArray.primitives( true )\n false\n\n\nisSymbolArray.objects( value )\n Tests if a value is an array-like object containing only `Symbol`\n objects.\n\n In pre-ES2015 environments, the function always returns `false`.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is an array-like object containing\n only `Symbol` objects.\n\n Examples\n --------\n > var bool = isSymbolArray.objects( [ Object( Symbol( 'beep' ) ) ] )\n true\n > bool = isSymbolArray.objects( [ Symbol( 'beep' ) ] )\n false\n > bool = isSymbolArray.objects( [] )\n false\n > bool = isSymbolArray.objects( {} )\n false\n > bool = isSymbolArray.objects( null )\n false\n > bool = isSymbolArray.objects( true )\n false\n\n See Also\n --------\n isArray, isSymbol\n",
1138
+
"isSymmetricMatrix": "\nisSymmetricMatrix( value )\n Tests if a value is a square matrix which equals its transpose.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a symmetric matrix.\n\n Examples\n --------\n > var M = {};\n > M.data = [ 0, 1, 1, 2 ];\n > M.ndims = 2;\n > M.shape = [ 2, 2 ];\n > M.strides = [ 2, 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'generic';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isSymmetricMatrix( M )\n true\n > bool = isSymmetricMatrix( [ 1, 2, 3, 4 ] )\n false\n > bool = isSymmetricMatrix( 3.14 )\n false\n > bool = isSymmetricMatrix( {} )\n false\n\n See Also\n --------\n isMatrixLike, isSquareMatrix\n",
1138
1139
"isSyntaxError": "\nisSyntaxError( value )\n Tests if a value is a SyntaxError object.\n\n This function should *not* be considered robust. While the function should\n always return `true` if provided a SyntaxError (or a descendant) object,\n false positives may occur due to the fact that the SyntaxError constructor\n inherits from Error and has no internal class of its own. Hence, SyntaxError\n impersonation is possible.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a SyntaxError object.\n\n Examples\n --------\n > var bool = isSyntaxError( new SyntaxError( 'beep' ) )\n true\n > bool = isSyntaxError( {} )\n false\n\n See Also\n --------\n isError\n",
1139
1140
"isTruthy": "\nisTruthy( value )\n Tests if a value is a value which translates to `true` when evaluated in a\n boolean context.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is truthy.\n\n Examples\n --------\n > var bool = isTruthy( true )\n true\n > bool = isTruthy( {} )\n true\n > bool = isTruthy( [] )\n true\n > bool = isTruthy( false )\n false\n > bool = isTruthy( '' )\n false\n > bool = isTruthy( 0 )\n false\n > bool = isTruthy( null )\n false\n > bool = isTruthy( void 0 )\n false\n > bool = isTruthy( NaN )\n false\n\n See Also\n --------\n isFalsy\n",
1140
1141
"isTruthyArray": "\nisTruthyArray( value )\n Tests if a value is an array-like object containing only truthy values.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is an array-like object containing\n only truthy values.\n\n Examples\n --------\n > var bool = isTruthyArray( [ {}, [] ] )\n true\n > bool = isTruthyArray( [ null, '' ] )\n false\n > bool = isTruthyArray( [] )\n false\n\n See Also\n --------\n isFalsyArray, isTruthy\n",
0 commit comments