README.md (89022B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Assert 22 23 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url] 24 25 > Standard library assertion utilities. 26 27 <section class="installation"> 28 29 ## Installation 30 31 ```bash 32 npm install @stdlib/assert 33 ``` 34 35 </section> 36 37 <section class="usage"> 38 39 ## Usage 40 41 ```javascript 42 var assert = require( '@stdlib/assert' ); 43 ``` 44 45 #### assert 46 47 Included in this namespace is a comprehensive suite of assertion utilities, such as utilities for testing for various data types and others for testing for JavaScript feature support. 48 49 ```javascript 50 var o = assert; 51 // returns {...} 52 ``` 53 54 To validate the built-in JavaScript data types, the namespace includes the following assertion utilities: 55 56 <!-- <toc pattern="is-+(array|boolean|date-object|function|string|symbol|nan|null|number|object|regexp|symbol|undefined)" > --> 57 58 <div class="namespace-toc"> 59 60 - <span class="signature">[`isArray( value )`][@stdlib/assert/is-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array.</span> 61 - <span class="signature">[`isBoolean( value )`][@stdlib/assert/is-boolean]</span><span class="delimiter">: </span><span class="description">test if a value is a boolean.</span> 62 - <span class="signature">[`isDateObject( value )`][@stdlib/assert/is-date-object]</span><span class="delimiter">: </span><span class="description">test if a value is a Date object.</span> 63 - <span class="signature">[`isFunction( value )`][@stdlib/assert/is-function]</span><span class="delimiter">: </span><span class="description">test if a value is a function.</span> 64 - <span class="signature">[`isnan( value )`][@stdlib/assert/is-nan]</span><span class="delimiter">: </span><span class="description">test if a value is NaN.</span> 65 - <span class="signature">[`isNull( value )`][@stdlib/assert/is-null]</span><span class="delimiter">: </span><span class="description">test if a value is null.</span> 66 - <span class="signature">[`isNumber( value )`][@stdlib/assert/is-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number.</span> 67 - <span class="signature">[`isObject( value )`][@stdlib/assert/is-object]</span><span class="delimiter">: </span><span class="description">test if a value is an object.</span> 68 - <span class="signature">[`isRegExp( value )`][@stdlib/assert/is-regexp]</span><span class="delimiter">: </span><span class="description">test if a value is a regular expression.</span> 69 - <span class="signature">[`isString( value )`][@stdlib/assert/is-string]</span><span class="delimiter">: </span><span class="description">test if a value is a string.</span> 70 - <span class="signature">[`isSymbol( value )`][@stdlib/assert/is-symbol]</span><span class="delimiter">: </span><span class="description">test if a value is a symbol.</span> 71 - <span class="signature">[`isUndefined( value )`][@stdlib/assert/is-undefined]</span><span class="delimiter">: </span><span class="description">test if a value is undefined.</span> 72 73 </div> 74 75 <!-- </toc> --> 76 77 For primitive types having corresponding object wrappers, assertion utilities provide `isObject` and `isPrimitive` methods to test for either objects or primitives, respectively. 78 79 <!-- eslint-disable no-new-wrappers --> 80 81 ```javascript 82 var isBoolean = require( '@stdlib/assert/is-boolean' ); 83 84 var bool = isBoolean.isObject( new Boolean( false ) ); 85 // returns true 86 87 bool = isBoolean.isObject( false ); 88 // returns false 89 90 bool = isBoolean.isPrimitive( false ); 91 // returns true 92 ``` 93 94 Many of the assertion utilities have corresponding packages that test whether array elements are of the given data type: 95 96 <!-- <toc pattern="is-+(array|boolean|date-object|function|string|nan|number|object|regexp|symbol|null|undefined)-array" > --> 97 98 <div class="namespace-toc"> 99 100 - <span class="signature">[`isArrayArray( value )`][@stdlib/assert/is-array-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array of arrays.</span> 101 - <span class="signature">[`isBooleanArray( value )`][@stdlib/assert/is-boolean-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object of booleans.</span> 102 - <span class="signature">[`isFunctionArray( value )`][@stdlib/assert/is-function-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only functions.</span> 103 - <span class="signature">[`isNaNArray( value )`][@stdlib/assert/is-nan-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only NaN values.</span> 104 - <span class="signature">[`isNullArray( value )`][@stdlib/assert/is-null-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only null values.</span> 105 - <span class="signature">[`isNumberArray( value )`][@stdlib/assert/is-number-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object of numbers.</span> 106 - <span class="signature">[`isObjectArray( value )`][@stdlib/assert/is-object-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only objects.</span> 107 - <span class="signature">[`isStringArray( value )`][@stdlib/assert/is-string-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array of strings.</span> 108 - <span class="signature">[`isSymbolArray( value )`][@stdlib/assert/is-symbol-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only symbols.</span> 109 110 </div> 111 112 <!-- </toc> --> 113 114 Where applicable, similar to the assertion utilities for built-in data types, array assertion utilities provides methods for testing for an array of primitives or objects. 115 116 <!-- eslint-disable no-new-wrappers --> 117 118 ```javascript 119 var isStringArray = require( '@stdlib/assert/is-string-array' ); 120 121 var bool = isStringArray( [ 'hello', 'world' ] ); 122 // returns true 123 124 bool = isStringArray.primitives( [ 'hello', 'world' ] ); 125 // returns true 126 127 bool = isStringArray.objects( [ 'hello', 'world' ] ); 128 // returns false 129 130 bool = isStringArray.objects( [ new String( 'hello' ), new String( 'world' ) ] ); 131 // returns true 132 ``` 133 134 The namespace also contains utilities to test for numbers within a certain range or for numbers satisfying a particular "type": 135 136 <!-- <toc pattern="is-*+(number|integer)*" ignore="is-number-array" ignore="is-number" > --> 137 138 <div class="namespace-toc"> 139 140 - <span class="signature">[`isCubeNumber( value )`][@stdlib/assert/is-cube-number]</span><span class="delimiter">: </span><span class="description">test if a value is a cube number.</span> 141 - <span class="signature">[`isIntegerArray( value )`][@stdlib/assert/is-integer-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only integers.</span> 142 - <span class="signature">[`isInteger( value )`][@stdlib/assert/is-integer]</span><span class="delimiter">: </span><span class="description">test if a value is a number having an integer value.</span> 143 - <span class="signature">[`isNegativeIntegerArray( value )`][@stdlib/assert/is-negative-integer-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only negative integers.</span> 144 - <span class="signature">[`isNegativeInteger( value )`][@stdlib/assert/is-negative-integer]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a negative integer value.</span> 145 - <span class="signature">[`isNegativeNumberArray( value )`][@stdlib/assert/is-negative-number-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only negative numbers.</span> 146 - <span class="signature">[`isNegativeNumber( value )`][@stdlib/assert/is-negative-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a negative value.</span> 147 - <span class="signature">[`isNonNegativeIntegerArray( value )`][@stdlib/assert/is-nonnegative-integer-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only nonnegative integers.</span> 148 - <span class="signature">[`isNonNegativeInteger( value )`][@stdlib/assert/is-nonnegative-integer]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a nonnegative integer value.</span> 149 - <span class="signature">[`isNonNegativeNumberArray( value )`][@stdlib/assert/is-nonnegative-number-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only nonnegative numbers.</span> 150 - <span class="signature">[`isNonNegativeNumber( value )`][@stdlib/assert/is-nonnegative-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a nonnegative value.</span> 151 - <span class="signature">[`isNonPositiveIntegerArray( value )`][@stdlib/assert/is-nonpositive-integer-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only nonpositive integers.</span> 152 - <span class="signature">[`isNonPositiveInteger( value )`][@stdlib/assert/is-nonpositive-integer]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a nonpositive integer value.</span> 153 - <span class="signature">[`isNonPositiveNumberArray( value )`][@stdlib/assert/is-nonpositive-number-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only nonpositive numbers.</span> 154 - <span class="signature">[`isNonPositiveNumber( value )`][@stdlib/assert/is-nonpositive-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a nonpositive value.</span> 155 - <span class="signature">[`isPositiveIntegerArray( value )`][@stdlib/assert/is-positive-integer-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only positive integers.</span> 156 - <span class="signature">[`isPositiveInteger( value )`][@stdlib/assert/is-positive-integer]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a positive integer value.</span> 157 - <span class="signature">[`isPositiveNumberArray( value )`][@stdlib/assert/is-positive-number-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only positive numbers.</span> 158 - <span class="signature">[`isPositiveNumber( value )`][@stdlib/assert/is-positive-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a positive value.</span> 159 - <span class="signature">[`isSafeIntegerArray( value )`][@stdlib/assert/is-safe-integer-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only safe integers.</span> 160 - <span class="signature">[`isSafeInteger( value )`][@stdlib/assert/is-safe-integer]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a safe integer value.</span> 161 - <span class="signature">[`isSquareNumber( value )`][@stdlib/assert/is-square-number]</span><span class="delimiter">: </span><span class="description">test if a value is a square number.</span> 162 - <span class="signature">[`isSquareTriangularNumber( value )`][@stdlib/assert/is-square-triangular-number]</span><span class="delimiter">: </span><span class="description">test if a value is a square triangular number.</span> 163 - <span class="signature">[`isTriangularNumber( value )`][@stdlib/assert/is-triangular-number]</span><span class="delimiter">: </span><span class="description">test if a value is a triangular number.</span> 164 165 </div> 166 167 <!-- </toc> --> 168 169 The namespace provides various utilities for validating typed arrays: 170 171 <!-- <toc pattern="is-+(int8|int16|int32|uint8clamped|uint8|uint16|uint32|float32|float64)array"> --> 172 173 <div class="namespace-toc"> 174 175 - <span class="signature">[`isFloat32Array( value )`][@stdlib/assert/is-float32array]</span><span class="delimiter">: </span><span class="description">test if a value is a Float32Array.</span> 176 - <span class="signature">[`isFloat64Array( value )`][@stdlib/assert/is-float64array]</span><span class="delimiter">: </span><span class="description">test if a value is a Float64Array.</span> 177 - <span class="signature">[`isInt16Array( value )`][@stdlib/assert/is-int16array]</span><span class="delimiter">: </span><span class="description">test if a value is an Int16Array.</span> 178 - <span class="signature">[`isInt32Array( value )`][@stdlib/assert/is-int32array]</span><span class="delimiter">: </span><span class="description">test if a value is an Int32Array.</span> 179 - <span class="signature">[`isInt8Array( value )`][@stdlib/assert/is-int8array]</span><span class="delimiter">: </span><span class="description">test if a value is an Int8Array.</span> 180 - <span class="signature">[`isUint16Array( value )`][@stdlib/assert/is-uint16array]</span><span class="delimiter">: </span><span class="description">test if a value is a Uint16Array.</span> 181 - <span class="signature">[`isUint32Array( value )`][@stdlib/assert/is-uint32array]</span><span class="delimiter">: </span><span class="description">test if a value is a Uint32Array.</span> 182 - <span class="signature">[`isUint8Array( value )`][@stdlib/assert/is-uint8array]</span><span class="delimiter">: </span><span class="description">test if a value is a Uint8Array.</span> 183 - <span class="signature">[`isUint8ClampedArray( value )`][@stdlib/assert/is-uint8clampedarray]</span><span class="delimiter">: </span><span class="description">test if a value is a Uint8ClampedArray.</span> 184 185 </div> 186 187 <!-- </toc> --> 188 189 The namespace includes utilities for validating `ndarray`s (n-dimensional arrays). 190 191 <!-- <toc keywords="+ndarray" > --> 192 193 <div class="namespace-toc"> 194 195 - <span class="signature">[`isCentrosymmetricMatrix( value )`][@stdlib/assert/is-centrosymmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a centrosymmetric matrix.</span> 196 - <span class="signature">[`isFloat32MatrixLike( value )`][@stdlib/assert/is-float32matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object containing single-precision floating-point numbers.</span> 197 - <span class="signature">[`isFloat32ndarrayLike( value )`][@stdlib/assert/is-float32ndarray-like]</span><span class="delimiter">: </span><span class="description">test if a value is an ndarray-like object containing single-precision floating-point numbers.</span> 198 - <span class="signature">[`isFloat32VectorLike( value )`][@stdlib/assert/is-float32vector-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 1-dimensional ndarray-like object containing single-precision floating-point numbers.</span> 199 - <span class="signature">[`isFloat64MatrixLike( value )`][@stdlib/assert/is-float64matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object containing double-precision floating-point numbers.</span> 200 - <span class="signature">[`isFloat64ndarrayLike( value )`][@stdlib/assert/is-float64ndarray-like]</span><span class="delimiter">: </span><span class="description">test if a value is an ndarray-like object containing double-precision floating-point numbers.</span> 201 - <span class="signature">[`isFloat64VectorLike( value )`][@stdlib/assert/is-float64vector-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 1-dimensional ndarray-like object containing double-precision floating-point numbers.</span> 202 - <span class="signature">[`isMatrixLike( value )`][@stdlib/assert/is-matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is 2-dimensional ndarray-like object.</span> 203 - <span class="signature">[`isndarrayLike( value )`][@stdlib/assert/is-ndarray-like]</span><span class="delimiter">: </span><span class="description">test if a value is ndarray-like.</span> 204 - <span class="signature">[`isNonSymmetricMatrix( value )`][@stdlib/assert/is-nonsymmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a non-symmetric matrix.</span> 205 - <span class="signature">[`isPersymmetricMatrix( value )`][@stdlib/assert/is-persymmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a persymmetric matrix.</span> 206 - <span class="signature">[`isSkewCentrosymmetricMatrix( value )`][@stdlib/assert/is-skew-centrosymmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a skew-centrosymmetric matrix.</span> 207 - <span class="signature">[`isSkewPersymmetricMatrix( value )`][@stdlib/assert/is-skew-persymmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a skew-persymmetric matrix.</span> 208 - <span class="signature">[`isSkewSymmetricMatrix( value )`][@stdlib/assert/is-skew-symmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a skew-symmetric matrix.</span> 209 - <span class="signature">[`isSquareMatrix( value )`][@stdlib/assert/is-square-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object having equal dimensions.</span> 210 - <span class="signature">[`isSymmetricMatrix( value )`][@stdlib/assert/is-symmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a symmetric matrix.</span> 211 - <span class="signature">[`isVectorLike( value )`][@stdlib/assert/is-vector-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 1-dimensional ndarray-like object.</span> 212 213 </div> 214 215 <!-- </toc> --> 216 217 The namespace includes utilities for validating complex numbers and arrays of complex numbers: 218 219 <!-- <toc pattern="is-complex*" > --> 220 221 <div class="namespace-toc"> 222 223 - <span class="signature">[`isComplexLike( value )`][@stdlib/assert/is-complex-like]</span><span class="delimiter">: </span><span class="description">test if a value is a complex number-like object.</span> 224 - <span class="signature">[`isComplexTypedArrayLike( value )`][@stdlib/assert/is-complex-typed-array-like]</span><span class="delimiter">: </span><span class="description">test if a value is complex-typed-array-like.</span> 225 - <span class="signature">[`isComplexTypedArray( value )`][@stdlib/assert/is-complex-typed-array]</span><span class="delimiter">: </span><span class="description">test if a value is a complex typed array.</span> 226 - <span class="signature">[`isComplex( value )`][@stdlib/assert/is-complex]</span><span class="delimiter">: </span><span class="description">test if a value is a 64-bit or 128-bit complex number.</span> 227 - <span class="signature">[`isComplex128( value )`][@stdlib/assert/is-complex128]</span><span class="delimiter">: </span><span class="description">test if a value is a 128-bit complex number.</span> 228 - <span class="signature">[`isComplex128Array( value )`][@stdlib/assert/is-complex128array]</span><span class="delimiter">: </span><span class="description">test if a value is a Complex128Array.</span> 229 - <span class="signature">[`isComplex64( value )`][@stdlib/assert/is-complex64]</span><span class="delimiter">: </span><span class="description">test if a value is a 64-bit complex number.</span> 230 - <span class="signature">[`isComplex64Array( value )`][@stdlib/assert/is-complex64array]</span><span class="delimiter">: </span><span class="description">test if a value is a Complex64Array.</span> 231 232 </div> 233 234 <!-- </toc> --> 235 236 The namespace includes utilities for validating other special arrays or buffers: 237 238 <!-- <toc pattern="is-*array*" ignore="is-+(int8|int16|int32|uint8clamped|uint8|uint16|uint32|float32|float64)array" ignore="is-*+(number|integer)*" ignore="is-+(array|boolean|date-object|function|string|nan|number|object|primitive|regexp|symbol|null|undefined)-array" ignore="is-array" keywords="-ndarray" > --> 239 240 <div class="namespace-toc"> 241 242 - <span class="signature">[`isArrayLength( value )`][@stdlib/assert/is-array-length]</span><span class="delimiter">: </span><span class="description">test if a value is a valid array length.</span> 243 - <span class="signature">[`isArrayLikeObject( value )`][@stdlib/assert/is-array-like-object]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object.</span> 244 - <span class="signature">[`isArrayLike( value )`][@stdlib/assert/is-array-like]</span><span class="delimiter">: </span><span class="description">test if a value is array-like.</span> 245 - <span class="signature">[`isArrayBufferView( value )`][@stdlib/assert/is-arraybuffer-view]</span><span class="delimiter">: </span><span class="description">test if a value is an ArrayBuffer view.</span> 246 - <span class="signature">[`isArrayBuffer( value )`][@stdlib/assert/is-arraybuffer]</span><span class="delimiter">: </span><span class="description">test if a value is an ArrayBuffer.</span> 247 - <span class="signature">[`isBetweenArray( value, a, b[, left, right] )`][@stdlib/assert/is-between-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object where every element is between two values.</span> 248 - <span class="signature">[`isBigInt64Array( value )`][@stdlib/assert/is-bigint64array]</span><span class="delimiter">: </span><span class="description">test if a value is a BigInt64Array.</span> 249 - <span class="signature">[`isBigUint64Array( value )`][@stdlib/assert/is-biguint64array]</span><span class="delimiter">: </span><span class="description">test if a value is a BigUint64Array.</span> 250 - <span class="signature">[`isCircularArray( value )`][@stdlib/assert/is-circular-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array containing a circular reference.</span> 251 - <span class="signature">[`isEmptyArray( value )`][@stdlib/assert/is-empty-array]</span><span class="delimiter">: </span><span class="description">test if a value is an empty array.</span> 252 - <span class="signature">[`isFalsyArray( value )`][@stdlib/assert/is-falsy-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only falsy values.</span> 253 - <span class="signature">[`isFiniteArray( value )`][@stdlib/assert/is-finite-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only finite numbers.</span> 254 - <span class="signature">[`isNumericArray( value )`][@stdlib/assert/is-numeric-array]</span><span class="delimiter">: </span><span class="description">test if a value is a numeric array.</span> 255 - <span class="signature">[`isPlainObjectArray( value )`][@stdlib/assert/is-plain-object-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only plain objects.</span> 256 - <span class="signature">[`isProbabilityArray( value )`][@stdlib/assert/is-probability-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only probabilities.</span> 257 - <span class="signature">[`isSharedArrayBuffer( value )`][@stdlib/assert/is-sharedarraybuffer]</span><span class="delimiter">: </span><span class="description">test if a value is a SharedArrayBuffer.</span> 258 - <span class="signature">[`isTruthyArray( value )`][@stdlib/assert/is-truthy-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only truthy values.</span> 259 - <span class="signature">[`isTypedArrayLength( value )`][@stdlib/assert/is-typed-array-length]</span><span class="delimiter">: </span><span class="description">test if a value is a valid typed array length.</span> 260 - <span class="signature">[`isTypedArrayLike( value )`][@stdlib/assert/is-typed-array-like]</span><span class="delimiter">: </span><span class="description">test if a value is typed-array-like.</span> 261 - <span class="signature">[`isTypedArray( value )`][@stdlib/assert/is-typed-array]</span><span class="delimiter">: </span><span class="description">test if a value is a typed array.</span> 262 - <span class="signature">[`isUnityProbabilityArray( value )`][@stdlib/assert/is-unity-probability-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array of probabilities that sum to one.</span> 263 264 </div> 265 266 <!-- </toc> --> 267 268 To test for error objects, the namespace includes the following utilities: 269 270 <!-- <toc pattern="is-*error*" > --> 271 272 <div class="namespace-toc"> 273 274 - <span class="signature">[`isError( value )`][@stdlib/assert/is-error]</span><span class="delimiter">: </span><span class="description">test if a value is an Error object.</span> 275 - <span class="signature">[`isEvalError( value )`][@stdlib/assert/is-eval-error]</span><span class="delimiter">: </span><span class="description">test if a value is an EvalError object.</span> 276 - <span class="signature">[`isRangeError( value )`][@stdlib/assert/is-range-error]</span><span class="delimiter">: </span><span class="description">test if a value is a RangeError object.</span> 277 - <span class="signature">[`isReferenceError( value )`][@stdlib/assert/is-reference-error]</span><span class="delimiter">: </span><span class="description">test if a value is a ReferenceError object.</span> 278 - <span class="signature">[`isSyntaxError( value )`][@stdlib/assert/is-syntax-error]</span><span class="delimiter">: </span><span class="description">test if a value is a SyntaxError object.</span> 279 - <span class="signature">[`isTypeError( value )`][@stdlib/assert/is-type-error]</span><span class="delimiter">: </span><span class="description">test if a value is a TypeError object.</span> 280 - <span class="signature">[`isURIError( value )`][@stdlib/assert/is-uri-error]</span><span class="delimiter">: </span><span class="description">test if a value is a URIError object.</span> 281 282 </div> 283 284 <!-- </toc> --> 285 286 The namespace exposes the following constants concerning the current running process: 287 288 <!-- <toc pattern="is-+(browser|darwin|electron|electron-main|electron-renderer|little-endian|big-endian|node|web-worker|windows|docker|mobile|touch-device)" > --> 289 290 <div class="namespace-toc"> 291 292 - <span class="signature">[`IS_BIG_ENDIAN`][@stdlib/assert/is-big-endian]</span><span class="delimiter">: </span><span class="description">check if an environment is big endian.</span> 293 - <span class="signature">[`IS_BROWSER`][@stdlib/assert/is-browser]</span><span class="delimiter">: </span><span class="description">check if the runtime is a web browser.</span> 294 - <span class="signature">[`IS_DARWIN`][@stdlib/assert/is-darwin]</span><span class="delimiter">: </span><span class="description">boolean indicating if the current process is running on Darwin.</span> 295 - <span class="signature">[`IS_DOCKER`][@stdlib/assert/is-docker]</span><span class="delimiter">: </span><span class="description">check if the process is running in a Docker container.</span> 296 - <span class="signature">[`IS_ELECTRON_MAIN`][@stdlib/assert/is-electron-main]</span><span class="delimiter">: </span><span class="description">check if the runtime is the main Electron process.</span> 297 - <span class="signature">[`IS_ELECTRON_RENDERER`][@stdlib/assert/is-electron-renderer]</span><span class="delimiter">: </span><span class="description">check if the runtime is the Electron renderer process.</span> 298 - <span class="signature">[`IS_ELECTRON`][@stdlib/assert/is-electron]</span><span class="delimiter">: </span><span class="description">check if the runtime is Electron.</span> 299 - <span class="signature">[`IS_LITTLE_ENDIAN`][@stdlib/assert/is-little-endian]</span><span class="delimiter">: </span><span class="description">check if an environment is little endian.</span> 300 - <span class="signature">[`IS_MOBILE`][@stdlib/assert/is-mobile]</span><span class="delimiter">: </span><span class="description">check if the current environment is a mobile device.</span> 301 - <span class="signature">[`IS_NODE`][@stdlib/assert/is-node]</span><span class="delimiter">: </span><span class="description">check if the runtime is Node.js.</span> 302 - <span class="signature">[`IS_TOUCH_DEVICE`][@stdlib/assert/is-touch-device]</span><span class="delimiter">: </span><span class="description">check if the current environment is a touch device.</span> 303 - <span class="signature">[`IS_WEB_WORKER`][@stdlib/assert/is-web-worker]</span><span class="delimiter">: </span><span class="description">check if the runtime is a web worker.</span> 304 - <span class="signature">[`IS_WINDOWS`][@stdlib/assert/is-windows]</span><span class="delimiter">: </span><span class="description">boolean indicating if the current process is running on Windows.</span> 305 306 </div> 307 308 <!-- </toc> --> 309 310 To test whether a runtime environment supports certain features, the namespace includes the following utilities: 311 312 <!-- <toc pattern="has-*-support" > --> 313 314 <div class="namespace-toc"> 315 316 - <span class="signature">[`hasArrayBufferSupport()`][@stdlib/assert/has-arraybuffer-support]</span><span class="delimiter">: </span><span class="description">detect native `ArrayBuffer` support.</span> 317 - <span class="signature">[`hasArrowFunctionSupport()`][@stdlib/assert/has-arrow-function-support]</span><span class="delimiter">: </span><span class="description">detect native `arrow function` support.</span> 318 - <span class="signature">[`hasAsyncAwaitSupport()`][@stdlib/assert/has-async-await-support]</span><span class="delimiter">: </span><span class="description">detect native `async`/`await` support.</span> 319 - <span class="signature">[`hasAsyncIteratorSymbolSupport()`][@stdlib/assert/has-async-iterator-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.asyncIterator` support.</span> 320 - <span class="signature">[`hasBigIntSupport()`][@stdlib/assert/has-bigint-support]</span><span class="delimiter">: </span><span class="description">detect native `BigInt` support.</span> 321 - <span class="signature">[`hasBigInt64ArraySupport()`][@stdlib/assert/has-bigint64array-support]</span><span class="delimiter">: </span><span class="description">detect native `BigInt64Array` support.</span> 322 - <span class="signature">[`hasBigUint64ArraySupport()`][@stdlib/assert/has-biguint64array-support]</span><span class="delimiter">: </span><span class="description">detect native `BigUint64Array` support.</span> 323 - <span class="signature">[`hasClassSupport()`][@stdlib/assert/has-class-support]</span><span class="delimiter">: </span><span class="description">detect native `class` support.</span> 324 - <span class="signature">[`hasDataViewSupport()`][@stdlib/assert/has-dataview-support]</span><span class="delimiter">: </span><span class="description">detect native `DataView` support.</span> 325 - <span class="signature">[`hasDefinePropertiesSupport()`][@stdlib/assert/has-define-properties-support]</span><span class="delimiter">: </span><span class="description">detect `Object.defineProperties` support.</span> 326 - <span class="signature">[`hasDefinePropertySupport()`][@stdlib/assert/has-define-property-support]</span><span class="delimiter">: </span><span class="description">detect `Object.defineProperty` support.</span> 327 - <span class="signature">[`hasFloat32ArraySupport()`][@stdlib/assert/has-float32array-support]</span><span class="delimiter">: </span><span class="description">detect native `Float32Array` support.</span> 328 - <span class="signature">[`hasFloat64ArraySupport()`][@stdlib/assert/has-float64array-support]</span><span class="delimiter">: </span><span class="description">detect native `Float64Array` support.</span> 329 - <span class="signature">[`hasFunctionNameSupport()`][@stdlib/assert/has-function-name-support]</span><span class="delimiter">: </span><span class="description">detect native function `name` support.</span> 330 - <span class="signature">[`hasGeneratorSupport()`][@stdlib/assert/has-generator-support]</span><span class="delimiter">: </span><span class="description">detect native `generator function` support.</span> 331 - <span class="signature">[`hasGlobalThisSupport()`][@stdlib/assert/has-globalthis-support]</span><span class="delimiter">: </span><span class="description">detect `globalThis` support.</span> 332 - <span class="signature">[`hasInt16ArraySupport()`][@stdlib/assert/has-int16array-support]</span><span class="delimiter">: </span><span class="description">detect native `Int16Array` support.</span> 333 - <span class="signature">[`hasInt32ArraySupport()`][@stdlib/assert/has-int32array-support]</span><span class="delimiter">: </span><span class="description">detect native `Int32Array` support.</span> 334 - <span class="signature">[`hasInt8ArraySupport()`][@stdlib/assert/has-int8array-support]</span><span class="delimiter">: </span><span class="description">detect native `Int8Array` support.</span> 335 - <span class="signature">[`hasIteratorSymbolSupport()`][@stdlib/assert/has-iterator-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.iterator` support.</span> 336 - <span class="signature">[`hasMapSupport()`][@stdlib/assert/has-map-support]</span><span class="delimiter">: </span><span class="description">detect native `Map` support.</span> 337 - <span class="signature">[`hasNodeBufferSupport()`][@stdlib/assert/has-node-buffer-support]</span><span class="delimiter">: </span><span class="description">detect native `Buffer` support.</span> 338 - <span class="signature">[`hasProxySupport()`][@stdlib/assert/has-proxy-support]</span><span class="delimiter">: </span><span class="description">detect native `Proxy` support.</span> 339 - <span class="signature">[`hasSetSupport()`][@stdlib/assert/has-set-support]</span><span class="delimiter">: </span><span class="description">detect native `Set` support.</span> 340 - <span class="signature">[`hasSharedArrayBufferSupport()`][@stdlib/assert/has-sharedarraybuffer-support]</span><span class="delimiter">: </span><span class="description">detect native `SharedArrayBuffer` support.</span> 341 - <span class="signature">[`hasSymbolSupport()`][@stdlib/assert/has-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol` support.</span> 342 - <span class="signature">[`hasToStringTagSupport()`][@stdlib/assert/has-tostringtag-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.toStringTag` support.</span> 343 - <span class="signature">[`hasUint16ArraySupport()`][@stdlib/assert/has-uint16array-support]</span><span class="delimiter">: </span><span class="description">detect native `Uint16Array` support.</span> 344 - <span class="signature">[`hasUint32ArraySupport()`][@stdlib/assert/has-uint32array-support]</span><span class="delimiter">: </span><span class="description">detect native `Uint32Array` support.</span> 345 - <span class="signature">[`hasUint8ArraySupport()`][@stdlib/assert/has-uint8array-support]</span><span class="delimiter">: </span><span class="description">detect native `Uint8Array` support.</span> 346 - <span class="signature">[`hasUint8ClampedArraySupport()`][@stdlib/assert/has-uint8clampedarray-support]</span><span class="delimiter">: </span><span class="description">detect native `Uint8ClampedArray` support.</span> 347 - <span class="signature">[`hasWebAssemblySupport()`][@stdlib/assert/has-wasm-support]</span><span class="delimiter">: </span><span class="description">detect native WebAssembly support.</span> 348 - <span class="signature">[`hasWeakMapSupport()`][@stdlib/assert/has-weakmap-support]</span><span class="delimiter">: </span><span class="description">detect native `WeakMap` support.</span> 349 - <span class="signature">[`hasWeakSetSupport()`][@stdlib/assert/has-weakset-support]</span><span class="delimiter">: </span><span class="description">detect native `WeakSet` support.</span> 350 351 </div> 352 353 <!-- </toc> --> 354 355 The remaining namespace utilities are as follows: 356 357 <!-- <toc ignore="is-+(array|boolean|date-object|function|string|symbol|nan|null|number|object|regexp|symbol|undefined)" ignore="is-*+(number|integer)*" ignore="is-*array*" ignore="is-*error*" ignore="is-+(browser|darwin|electron|electron-main|electron-renderer|little-endian|node|web-worker|windows)" ignore="has-*-support" keywords="-ndarray" > --> 358 359 <div class="namespace-toc"> 360 361 - <span class="signature">[`contains( val, searchValue[, position] )`][@stdlib/assert/contains]</span><span class="delimiter">: </span><span class="description">test if an array-like value contains a search value.</span> 362 - <span class="signature">[`deepEqual( a, b )`][@stdlib/assert/deep-equal]</span><span class="delimiter">: </span><span class="description">test for deep equality between two values.</span> 363 - <span class="signature">[`deepHasOwnProp( value, path[, options] )`][@stdlib/assert/deep-has-own-property]</span><span class="delimiter">: </span><span class="description">test whether an object contains a nested key path.</span> 364 - <span class="signature">[`deepHasProp( value, path[, options] )`][@stdlib/assert/deep-has-property]</span><span class="delimiter">: </span><span class="description">test whether an object contains a nested key path, either own or inherited.</span> 365 - <span class="signature">[`hasOwnProp( value, property )`][@stdlib/assert/has-own-property]</span><span class="delimiter">: </span><span class="description">test if an object has a specified property.</span> 366 - <span class="signature">[`hasProp( value, property )`][@stdlib/assert/has-property]</span><span class="delimiter">: </span><span class="description">test if an object has a specified property, either own or inherited.</span> 367 - <span class="signature">[`hasUTF16SurrogatePairAt( string, position )`][@stdlib/assert/has-utf16-surrogate-pair-at]</span><span class="delimiter">: </span><span class="description">test if a position in a string marks the start of a UTF-16 surrogate pair.</span> 368 - <span class="signature">[`instanceOf( value, constructor )`][@stdlib/assert/instance-of]</span><span class="delimiter">: </span><span class="description">test whether a value has in its prototype chain a specified constructor as a prototype property.</span> 369 - <span class="signature">[`isAbsolutePath( value )`][@stdlib/assert/is-absolute-path]</span><span class="delimiter">: </span><span class="description">test if a value is an absolute path.</span> 370 - <span class="signature">[`isAccessorPropertyIn( value, property )`][@stdlib/assert/is-accessor-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property has an accessor descriptor.</span> 371 - <span class="signature">[`isAccessorProperty( value, property )`][@stdlib/assert/is-accessor-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property has an accessor descriptor.</span> 372 - <span class="signature">[`isAlphagram( value )`][@stdlib/assert/is-alphagram]</span><span class="delimiter">: </span><span class="description">test if a value is an alphagram.</span> 373 - <span class="signature">[`isAlphaNumeric( value )`][@stdlib/assert/is-alphanumeric]</span><span class="delimiter">: </span><span class="description">test whether a string contains only alphanumeric characters.</span> 374 - <span class="signature">[`isAnagram( str, value )`][@stdlib/assert/is-anagram]</span><span class="delimiter">: </span><span class="description">test if a value is an anagram.</span> 375 - <span class="signature">[`isArguments( value )`][@stdlib/assert/is-arguments]</span><span class="delimiter">: </span><span class="description">test if a value is an arguments object.</span> 376 - <span class="signature">[`isArrowFunction( value )`][@stdlib/assert/is-arrow-function]</span><span class="delimiter">: </span><span class="description">test if a value is an `arrow function`.</span> 377 - <span class="signature">[`isASCII( value )`][@stdlib/assert/is-ascii]</span><span class="delimiter">: </span><span class="description">test whether a character belongs to the ASCII character set and whether this is true for all characters in a provided string.</span> 378 - <span class="signature">[`isBetween( value, a, b[, left, right] )`][@stdlib/assert/is-between]</span><span class="delimiter">: </span><span class="description">test if a value is between two values.</span> 379 - <span class="signature">[`isBigInt( value )`][@stdlib/assert/is-bigint]</span><span class="delimiter">: </span><span class="description">test if a value is a BigInt.</span> 380 - <span class="signature">[`isBinaryString( value )`][@stdlib/assert/is-binary-string]</span><span class="delimiter">: </span><span class="description">test if a value is a binary string.</span> 381 - <span class="signature">[`isBoxedPrimitive( value )`][@stdlib/assert/is-boxed-primitive]</span><span class="delimiter">: </span><span class="description">test if a value is a JavaScript boxed primitive.</span> 382 - <span class="signature">[`isBuffer( value )`][@stdlib/assert/is-buffer]</span><span class="delimiter">: </span><span class="description">test if a value is a Buffer object.</span> 383 - <span class="signature">[`isCapitalized( value )`][@stdlib/assert/is-capitalized]</span><span class="delimiter">: </span><span class="description">test if a value is a string having an uppercase first character.</span> 384 - <span class="signature">[`isCircular( value )`][@stdlib/assert/is-circular]</span><span class="delimiter">: </span><span class="description">test if a value is a plain object containing a circular reference.</span> 385 - <span class="signature">[`isCircular( value )`][@stdlib/assert/is-circular]</span><span class="delimiter">: </span><span class="description">test if an object-like value contains a circular reference.</span> 386 - <span class="signature">[`isClass( value )`][@stdlib/assert/is-class]</span><span class="delimiter">: </span><span class="description">test if a value is a class.</span> 387 - <span class="signature">[`isCollection( value )`][@stdlib/assert/is-collection]</span><span class="delimiter">: </span><span class="description">test if a value is a collection.</span> 388 - <span class="signature">[`isComposite( value )`][@stdlib/assert/is-composite]</span><span class="delimiter">: </span><span class="description">test if a value is a composite number.</span> 389 - <span class="signature">[`isConfigurablePropertyIn( value, property )`][@stdlib/assert/is-configurable-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is configurable.</span> 390 - <span class="signature">[`isConfigurableProperty( value, property )`][@stdlib/assert/is-configurable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is configurable.</span> 391 - <span class="signature">[`isDataPropertyIn( value, property )`][@stdlib/assert/is-data-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property has a data descriptor.</span> 392 - <span class="signature">[`isDataProperty( value, property )`][@stdlib/assert/is-data-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property has a data descriptor.</span> 393 - <span class="signature">[`isDataView( value )`][@stdlib/assert/is-dataview]</span><span class="delimiter">: </span><span class="description">test if a value is a DataView.</span> 394 - <span class="signature">[`isDigitString( value )`][@stdlib/assert/is-digit-string]</span><span class="delimiter">: </span><span class="description">test whether a string contains only numeric digits.</span> 395 - <span class="signature">[`isEmailAddress( value )`][@stdlib/assert/is-email-address]</span><span class="delimiter">: </span><span class="description">test if a value is an email address.</span> 396 - <span class="signature">[`isEmptyObject( value )`][@stdlib/assert/is-empty-object]</span><span class="delimiter">: </span><span class="description">test if a value is an empty object.</span> 397 - <span class="signature">[`isEmptyString( value )`][@stdlib/assert/is-empty-string]</span><span class="delimiter">: </span><span class="description">test if a value is an empty string.</span> 398 - <span class="signature">[`isEnumerablePropertyIn( value, property )`][@stdlib/assert/is-enumerable-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is enumerable.</span> 399 - <span class="signature">[`isEnumerableProperty( value, property )`][@stdlib/assert/is-enumerable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is enumerable.</span> 400 - <span class="signature">[`isEven( value )`][@stdlib/assert/is-even]</span><span class="delimiter">: </span><span class="description">test if a value is an even number.</span> 401 - <span class="signature">[`isFalsy( value )`][@stdlib/assert/is-falsy]</span><span class="delimiter">: </span><span class="description">test if a value is falsy.</span> 402 - <span class="signature">[`isFinite( value )`][@stdlib/assert/is-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a finite number.</span> 403 - <span class="signature">[`isGeneratorObjectLike( value )`][@stdlib/assert/is-generator-object-like]</span><span class="delimiter">: </span><span class="description">test if a value is `generator` object-like.</span> 404 - <span class="signature">[`isGeneratorObject( value )`][@stdlib/assert/is-generator-object]</span><span class="delimiter">: </span><span class="description">test if a value is a `generator` object.</span> 405 - <span class="signature">[`isgzipBuffer( value )`][@stdlib/assert/is-gzip-buffer]</span><span class="delimiter">: </span><span class="description">test if a value is a gzip buffer.</span> 406 - <span class="signature">[`isHexString( value )`][@stdlib/assert/is-hex-string]</span><span class="delimiter">: </span><span class="description">test whether a string contains only hexadecimal digits.</span> 407 - <span class="signature">[`isInfinite( value )`][@stdlib/assert/is-infinite]</span><span class="delimiter">: </span><span class="description">test if a value is an infinite number.</span> 408 - <span class="signature">[`isInheritedProperty( value, property )`][@stdlib/assert/is-inherited-property]</span><span class="delimiter">: </span><span class="description">test if an object has an inherited property.</span> 409 - <span class="signature">[`isIterableLike( value )`][@stdlib/assert/is-iterable-like]</span><span class="delimiter">: </span><span class="description">test if a value is `iterable`-like.</span> 410 - <span class="signature">[`isIteratorLike( value )`][@stdlib/assert/is-iterator-like]</span><span class="delimiter">: </span><span class="description">test if a value is `iterator`-like.</span> 411 - <span class="signature">[`isJSON( value )`][@stdlib/assert/is-json]</span><span class="delimiter">: </span><span class="description">test if a value is a parseable JSON string.</span> 412 - <span class="signature">[`isLeapYear( [value] )`][@stdlib/assert/is-leap-year]</span><span class="delimiter">: </span><span class="description">test if a value corresponds to a leap year in the Gregorian calendar.</span> 413 - <span class="signature">[`isLowercase( value )`][@stdlib/assert/is-lowercase]</span><span class="delimiter">: </span><span class="description">test if a value is a lowercase string.</span> 414 - <span class="signature">[`isMethodIn( value, property )`][@stdlib/assert/is-method-in]</span><span class="delimiter">: </span><span class="description">test if an object has a specified method name, either own or inherited.</span> 415 - <span class="signature">[`isMethod( value, property )`][@stdlib/assert/is-method]</span><span class="delimiter">: </span><span class="description">test if an object has a specified method name.</span> 416 - <span class="signature">[`isNamedTypedTupleLike( value )`][@stdlib/assert/is-named-typed-tuple-like]</span><span class="delimiter">: </span><span class="description">test if a value is named typed tuple-like.</span> 417 - <span class="signature">[`isNativeFunction( value )`][@stdlib/assert/is-native-function]</span><span class="delimiter">: </span><span class="description">test if a value is a native function.</span> 418 - <span class="signature">[`isNegativeZero( value )`][@stdlib/assert/is-negative-zero]</span><span class="delimiter">: </span><span class="description">test if a value is a number equal to negative zero.</span> 419 - <span class="signature">[`isNodeBuiltin( value )`][@stdlib/assert/is-node-builtin]</span><span class="delimiter">: </span><span class="description">test whether a string matches a Node.js built-in module name.</span> 420 - <span class="signature">[`isNodeDuplexStreamLike( value )`][@stdlib/assert/is-node-duplex-stream-like]</span><span class="delimiter">: </span><span class="description">test if a value is Node duplex stream-like.</span> 421 - <span class="signature">[`isNodeReadableStreamLike( value )`][@stdlib/assert/is-node-readable-stream-like]</span><span class="delimiter">: </span><span class="description">test if a value is Node readable stream-like.</span> 422 - <span class="signature">[`isNodeREPL()`][@stdlib/assert/is-node-repl]</span><span class="delimiter">: </span><span class="description">check if running in a Node.js REPL environment.</span> 423 - <span class="signature">[`isNodeStreamLike( value )`][@stdlib/assert/is-node-stream-like]</span><span class="delimiter">: </span><span class="description">test if a value is Node stream-like.</span> 424 - <span class="signature">[`isNodeTransformStreamLike( value )`][@stdlib/assert/is-node-transform-stream-like]</span><span class="delimiter">: </span><span class="description">test if a value is Node transform stream-like.</span> 425 - <span class="signature">[`isNodeWritableStreamLike( value )`][@stdlib/assert/is-node-writable-stream-like]</span><span class="delimiter">: </span><span class="description">test if a value is Node writable stream-like.</span> 426 - <span class="signature">[`isNonConfigurablePropertyIn( value, property )`][@stdlib/assert/is-nonconfigurable-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is non-configurable.</span> 427 - <span class="signature">[`isNonConfigurableProperty( value, property )`][@stdlib/assert/is-nonconfigurable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is non-configurable.</span> 428 - <span class="signature">[`isNonEnumerablePropertyIn( value, property )`][@stdlib/assert/is-nonenumerable-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is non-enumerable.</span> 429 - <span class="signature">[`isNonEnumerableProperty( value, property )`][@stdlib/assert/is-nonenumerable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is non-enumerable.</span> 430 - <span class="signature">[`isObjectLike( value )`][@stdlib/assert/is-object-like]</span><span class="delimiter">: </span><span class="description">test if a value is object-like.</span> 431 - <span class="signature">[`isOdd( value )`][@stdlib/assert/is-odd]</span><span class="delimiter">: </span><span class="description">test if a value is an odd number.</span> 432 - <span class="signature">[`isPlainObject( value )`][@stdlib/assert/is-plain-object]</span><span class="delimiter">: </span><span class="description">test if a value is a plain object.</span> 433 - <span class="signature">[`isPositiveZero( value )`][@stdlib/assert/is-positive-zero]</span><span class="delimiter">: </span><span class="description">test if a value is a number equal to positive zero.</span> 434 - <span class="signature">[`isPrime( value )`][@stdlib/assert/is-prime]</span><span class="delimiter">: </span><span class="description">test if a value is a prime number.</span> 435 - <span class="signature">[`isPrimitive( value )`][@stdlib/assert/is-primitive]</span><span class="delimiter">: </span><span class="description">test if a value is a JavaScript primitive.</span> 436 - <span class="signature">[`isPRNGLike( value )`][@stdlib/assert/is-prng-like]</span><span class="delimiter">: </span><span class="description">test if a value is PRNG-like.</span> 437 - <span class="signature">[`isProbability( value )`][@stdlib/assert/is-probability]</span><span class="delimiter">: </span><span class="description">test if a value is a probability.</span> 438 - <span class="signature">[`isPrototypeOf( obj, prototype )`][@stdlib/assert/is-prototype-of]</span><span class="delimiter">: </span><span class="description">test if an object's prototype chain contains a provided prototype.</span> 439 - <span class="signature">[`isReadOnlyPropertyIn( value, property )`][@stdlib/assert/is-read-only-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is read-only.</span> 440 - <span class="signature">[`isReadOnlyProperty( value, property )`][@stdlib/assert/is-read-only-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is read-only.</span> 441 - <span class="signature">[`isReadWritePropertyIn( value, property )`][@stdlib/assert/is-read-write-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is readable and writable.</span> 442 - <span class="signature">[`isReadWriteProperty( value, property )`][@stdlib/assert/is-read-write-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is readable and writable.</span> 443 - <span class="signature">[`isReadablePropertyIn( value, property )`][@stdlib/assert/is-readable-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is readable.</span> 444 - <span class="signature">[`isReadableProperty( value, property )`][@stdlib/assert/is-readable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is readable.</span> 445 - <span class="signature">[`isRegExpString( value )`][@stdlib/assert/is-regexp-string]</span><span class="delimiter">: </span><span class="description">test if a value is a regular expression string.</span> 446 - <span class="signature">[`isRelativePath( value )`][@stdlib/assert/is-relative-path]</span><span class="delimiter">: </span><span class="description">test if a value is a relative path.</span> 447 - <span class="signature">[`isSameValueZero( a, b )`][@stdlib/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span> 448 - <span class="signature">[`isSameValue( a, b )`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span> 449 - <span class="signature">[`isStrictEqual( a, b )`][@stdlib/assert/is-strict-equal]</span><span class="delimiter">: </span><span class="description">test if two arguments are strictly equal.</span> 450 - <span class="signature">[`isTruthy( value )`][@stdlib/assert/is-truthy]</span><span class="delimiter">: </span><span class="description">test if a value is truthy.</span> 451 - <span class="signature">[`isUNCPath( value )`][@stdlib/assert/is-unc-path]</span><span class="delimiter">: </span><span class="description">test if a value is a UNC path.</span> 452 - <span class="signature">[`isUndefinedOrNull( value )`][@stdlib/assert/is-undefined-or-null]</span><span class="delimiter">: </span><span class="description">test if a value is undefined or null.</span> 453 - <span class="signature">[`isUppercase( value )`][@stdlib/assert/is-uppercase]</span><span class="delimiter">: </span><span class="description">test if a value is an uppercase string.</span> 454 - <span class="signature">[`isURI( value )`][@stdlib/assert/is-uri]</span><span class="delimiter">: </span><span class="description">test if a value is a URI.</span> 455 - <span class="signature">[`isWhitespace( value )`][@stdlib/assert/is-whitespace]</span><span class="delimiter">: </span><span class="description">test whether a string contains only white space characters.</span> 456 - <span class="signature">[`isWritablePropertyIn( value, property )`][@stdlib/assert/is-writable-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is writable.</span> 457 - <span class="signature">[`isWritableProperty( value, property )`][@stdlib/assert/is-writable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is writable.</span> 458 - <span class="signature">[`isWriteOnlyPropertyIn( value, property )`][@stdlib/assert/is-write-only-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is write-only.</span> 459 - <span class="signature">[`isWriteOnlyProperty( value, property )`][@stdlib/assert/is-write-only-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is write-only.</span> 460 461 </div> 462 463 <!-- </toc> --> 464 465 </section> 466 467 <!-- /.usage --> 468 469 <section class="examples"> 470 471 ## Examples 472 473 <!-- TODO: better examples --> 474 475 <!-- eslint no-undef: "error" --> 476 477 ```javascript 478 var objectKeys = require( '@stdlib/utils/keys' ); 479 var assert = require( '@stdlib/assert' ); 480 481 console.log( objectKeys( assert ) ); 482 ``` 483 484 </section> 485 486 <!-- /.examples --> 487 488 489 <section class="main-repo" > 490 491 * * * 492 493 ## Notice 494 495 This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. 496 497 For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. 498 499 #### Community 500 501 [![Chat][chat-image]][chat-url] 502 503 --- 504 505 ## License 506 507 See [LICENSE][stdlib-license]. 508 509 510 ## Copyright 511 512 Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors]. 513 514 </section> 515 516 <!-- /.stdlib --> 517 518 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> 519 520 <section class="links"> 521 522 [npm-image]: http://img.shields.io/npm/v/@stdlib/assert.svg 523 [npm-url]: https://npmjs.org/package/@stdlib/assert 524 525 [test-image]: https://github.com/stdlib-js/assert/actions/workflows/test.yml/badge.svg 526 [test-url]: https://github.com/stdlib-js/assert/actions/workflows/test.yml 527 528 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert/main.svg 529 [coverage-url]: https://codecov.io/github/stdlib-js/assert?branch=main 530 531 [dependencies-image]: https://img.shields.io/david/stdlib-js/assert.svg 532 [dependencies-url]: https://david-dm.org/stdlib-js/assert/main 533 534 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg 535 [chat-url]: https://gitter.im/stdlib-js/stdlib/ 536 537 [stdlib]: https://github.com/stdlib-js/stdlib 538 539 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors 540 541 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert/main/LICENSE 542 543 <!-- <toc-links> --> 544 545 [@stdlib/assert/contains]: https://www.npmjs.com/package/@stdlib/assert/tree/main/contains 546 547 [@stdlib/assert/deep-equal]: https://www.npmjs.com/package/@stdlib/assert/tree/main/deep-equal 548 549 [@stdlib/assert/deep-has-own-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/deep-has-own-property 550 551 [@stdlib/assert/deep-has-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/deep-has-property 552 553 [@stdlib/assert/has-own-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-own-property 554 555 [@stdlib/assert/has-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-property 556 557 [@stdlib/assert/has-utf16-surrogate-pair-at]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-utf16-surrogate-pair-at 558 559 [@stdlib/assert/instance-of]: https://www.npmjs.com/package/@stdlib/assert/tree/main/instance-of 560 561 [@stdlib/assert/is-absolute-path]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-absolute-path 562 563 [@stdlib/assert/is-accessor-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-accessor-property-in 564 565 [@stdlib/assert/is-accessor-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-accessor-property 566 567 [@stdlib/assert/is-alphagram]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-alphagram 568 569 [@stdlib/assert/is-alphanumeric]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-alphanumeric 570 571 [@stdlib/assert/is-anagram]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-anagram 572 573 [@stdlib/assert/is-arguments]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-arguments 574 575 [@stdlib/assert/is-arrow-function]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-arrow-function 576 577 [@stdlib/assert/is-ascii]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-ascii 578 579 [@stdlib/assert/is-between]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-between 580 581 [@stdlib/assert/is-bigint]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-bigint 582 583 [@stdlib/assert/is-binary-string]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-binary-string 584 585 [@stdlib/assert/is-boxed-primitive]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-boxed-primitive 586 587 [@stdlib/assert/is-buffer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-buffer 588 589 [@stdlib/assert/is-capitalized]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-capitalized 590 591 [@stdlib/assert/is-circular]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-circular 592 593 [@stdlib/assert/is-class]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-class 594 595 [@stdlib/assert/is-collection]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-collection 596 597 [@stdlib/assert/is-composite]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-composite 598 599 [@stdlib/assert/is-configurable-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-configurable-property-in 600 601 [@stdlib/assert/is-configurable-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-configurable-property 602 603 [@stdlib/assert/is-data-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-data-property-in 604 605 [@stdlib/assert/is-data-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-data-property 606 607 [@stdlib/assert/is-dataview]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-dataview 608 609 [@stdlib/assert/is-digit-string]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-digit-string 610 611 [@stdlib/assert/is-email-address]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-email-address 612 613 [@stdlib/assert/is-empty-object]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-empty-object 614 615 [@stdlib/assert/is-empty-string]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-empty-string 616 617 [@stdlib/assert/is-enumerable-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-enumerable-property-in 618 619 [@stdlib/assert/is-enumerable-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-enumerable-property 620 621 [@stdlib/assert/is-even]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-even 622 623 [@stdlib/assert/is-falsy]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-falsy 624 625 [@stdlib/assert/is-finite]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-finite 626 627 [@stdlib/assert/is-generator-object-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-generator-object-like 628 629 [@stdlib/assert/is-generator-object]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-generator-object 630 631 [@stdlib/assert/is-gzip-buffer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-gzip-buffer 632 633 [@stdlib/assert/is-hex-string]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-hex-string 634 635 [@stdlib/assert/is-infinite]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-infinite 636 637 [@stdlib/assert/is-inherited-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-inherited-property 638 639 [@stdlib/assert/is-iterable-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-iterable-like 640 641 [@stdlib/assert/is-iterator-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-iterator-like 642 643 [@stdlib/assert/is-json]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-json 644 645 [@stdlib/assert/is-leap-year]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-leap-year 646 647 [@stdlib/assert/is-lowercase]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-lowercase 648 649 [@stdlib/assert/is-method-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-method-in 650 651 [@stdlib/assert/is-method]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-method 652 653 [@stdlib/assert/is-named-typed-tuple-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-named-typed-tuple-like 654 655 [@stdlib/assert/is-native-function]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-native-function 656 657 [@stdlib/assert/is-negative-zero]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-negative-zero 658 659 [@stdlib/assert/is-node-builtin]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-node-builtin 660 661 [@stdlib/assert/is-node-duplex-stream-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-node-duplex-stream-like 662 663 [@stdlib/assert/is-node-readable-stream-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-node-readable-stream-like 664 665 [@stdlib/assert/is-node-repl]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-node-repl 666 667 [@stdlib/assert/is-node-stream-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-node-stream-like 668 669 [@stdlib/assert/is-node-transform-stream-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-node-transform-stream-like 670 671 [@stdlib/assert/is-node-writable-stream-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-node-writable-stream-like 672 673 [@stdlib/assert/is-nonconfigurable-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonconfigurable-property-in 674 675 [@stdlib/assert/is-nonconfigurable-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonconfigurable-property 676 677 [@stdlib/assert/is-nonenumerable-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonenumerable-property-in 678 679 [@stdlib/assert/is-nonenumerable-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonenumerable-property 680 681 [@stdlib/assert/is-object-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-object-like 682 683 [@stdlib/assert/is-odd]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-odd 684 685 [@stdlib/assert/is-plain-object]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-plain-object 686 687 [@stdlib/assert/is-positive-zero]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-positive-zero 688 689 [@stdlib/assert/is-prime]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-prime 690 691 [@stdlib/assert/is-primitive]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-primitive 692 693 [@stdlib/assert/is-prng-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-prng-like 694 695 [@stdlib/assert/is-probability]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-probability 696 697 [@stdlib/assert/is-prototype-of]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-prototype-of 698 699 [@stdlib/assert/is-read-only-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-read-only-property-in 700 701 [@stdlib/assert/is-read-only-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-read-only-property 702 703 [@stdlib/assert/is-read-write-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-read-write-property-in 704 705 [@stdlib/assert/is-read-write-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-read-write-property 706 707 [@stdlib/assert/is-readable-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-readable-property-in 708 709 [@stdlib/assert/is-readable-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-readable-property 710 711 [@stdlib/assert/is-regexp-string]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-regexp-string 712 713 [@stdlib/assert/is-relative-path]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-relative-path 714 715 [@stdlib/assert/is-same-value-zero]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-same-value-zero 716 717 [@stdlib/assert/is-same-value]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-same-value 718 719 [@stdlib/assert/is-strict-equal]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-strict-equal 720 721 [@stdlib/assert/is-truthy]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-truthy 722 723 [@stdlib/assert/is-unc-path]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-unc-path 724 725 [@stdlib/assert/is-undefined-or-null]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-undefined-or-null 726 727 [@stdlib/assert/is-uppercase]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-uppercase 728 729 [@stdlib/assert/is-uri]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-uri 730 731 [@stdlib/assert/is-whitespace]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-whitespace 732 733 [@stdlib/assert/is-writable-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-writable-property-in 734 735 [@stdlib/assert/is-writable-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-writable-property 736 737 [@stdlib/assert/is-write-only-property-in]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-write-only-property-in 738 739 [@stdlib/assert/is-write-only-property]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-write-only-property 740 741 [@stdlib/assert/has-arraybuffer-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-arraybuffer-support 742 743 [@stdlib/assert/has-arrow-function-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-arrow-function-support 744 745 [@stdlib/assert/has-async-await-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-async-await-support 746 747 [@stdlib/assert/has-async-iterator-symbol-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-async-iterator-symbol-support 748 749 [@stdlib/assert/has-bigint-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-bigint-support 750 751 [@stdlib/assert/has-bigint64array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-bigint64array-support 752 753 [@stdlib/assert/has-biguint64array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-biguint64array-support 754 755 [@stdlib/assert/has-class-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-class-support 756 757 [@stdlib/assert/has-dataview-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-dataview-support 758 759 [@stdlib/assert/has-define-properties-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-define-properties-support 760 761 [@stdlib/assert/has-define-property-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-define-property-support 762 763 [@stdlib/assert/has-float32array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-float32array-support 764 765 [@stdlib/assert/has-float64array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-float64array-support 766 767 [@stdlib/assert/has-function-name-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-function-name-support 768 769 [@stdlib/assert/has-generator-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-generator-support 770 771 [@stdlib/assert/has-globalthis-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-globalthis-support 772 773 [@stdlib/assert/has-int16array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-int16array-support 774 775 [@stdlib/assert/has-int32array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-int32array-support 776 777 [@stdlib/assert/has-int8array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-int8array-support 778 779 [@stdlib/assert/has-iterator-symbol-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-iterator-symbol-support 780 781 [@stdlib/assert/has-map-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-map-support 782 783 [@stdlib/assert/has-node-buffer-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-node-buffer-support 784 785 [@stdlib/assert/has-proxy-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-proxy-support 786 787 [@stdlib/assert/has-set-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-set-support 788 789 [@stdlib/assert/has-sharedarraybuffer-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-sharedarraybuffer-support 790 791 [@stdlib/assert/has-symbol-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-symbol-support 792 793 [@stdlib/assert/has-tostringtag-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-tostringtag-support 794 795 [@stdlib/assert/has-uint16array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-uint16array-support 796 797 [@stdlib/assert/has-uint32array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-uint32array-support 798 799 [@stdlib/assert/has-uint8array-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-uint8array-support 800 801 [@stdlib/assert/has-uint8clampedarray-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-uint8clampedarray-support 802 803 [@stdlib/assert/has-wasm-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-wasm-support 804 805 [@stdlib/assert/has-weakmap-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-weakmap-support 806 807 [@stdlib/assert/has-weakset-support]: https://www.npmjs.com/package/@stdlib/assert/tree/main/has-weakset-support 808 809 [@stdlib/assert/is-big-endian]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-big-endian 810 811 [@stdlib/assert/is-browser]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-browser 812 813 [@stdlib/assert/is-darwin]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-darwin 814 815 [@stdlib/assert/is-docker]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-docker 816 817 [@stdlib/assert/is-electron-main]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-electron-main 818 819 [@stdlib/assert/is-electron-renderer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-electron-renderer 820 821 [@stdlib/assert/is-electron]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-electron 822 823 [@stdlib/assert/is-little-endian]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-little-endian 824 825 [@stdlib/assert/is-mobile]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-mobile 826 827 [@stdlib/assert/is-node]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-node 828 829 [@stdlib/assert/is-touch-device]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-touch-device 830 831 [@stdlib/assert/is-web-worker]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-web-worker 832 833 [@stdlib/assert/is-windows]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-windows 834 835 [@stdlib/assert/is-error]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-error 836 837 [@stdlib/assert/is-eval-error]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-eval-error 838 839 [@stdlib/assert/is-range-error]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-range-error 840 841 [@stdlib/assert/is-reference-error]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-reference-error 842 843 [@stdlib/assert/is-syntax-error]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-syntax-error 844 845 [@stdlib/assert/is-type-error]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-type-error 846 847 [@stdlib/assert/is-uri-error]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-uri-error 848 849 [@stdlib/assert/is-array-length]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-array-length 850 851 [@stdlib/assert/is-array-like-object]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-array-like-object 852 853 [@stdlib/assert/is-array-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-array-like 854 855 [@stdlib/assert/is-arraybuffer-view]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-arraybuffer-view 856 857 [@stdlib/assert/is-arraybuffer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-arraybuffer 858 859 [@stdlib/assert/is-between-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-between-array 860 861 [@stdlib/assert/is-bigint64array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-bigint64array 862 863 [@stdlib/assert/is-biguint64array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-biguint64array 864 865 [@stdlib/assert/is-circular-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-circular-array 866 867 [@stdlib/assert/is-empty-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-empty-array 868 869 [@stdlib/assert/is-falsy-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-falsy-array 870 871 [@stdlib/assert/is-finite-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-finite-array 872 873 [@stdlib/assert/is-numeric-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-numeric-array 874 875 [@stdlib/assert/is-plain-object-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-plain-object-array 876 877 [@stdlib/assert/is-probability-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-probability-array 878 879 [@stdlib/assert/is-sharedarraybuffer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-sharedarraybuffer 880 881 [@stdlib/assert/is-truthy-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-truthy-array 882 883 [@stdlib/assert/is-typed-array-length]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-typed-array-length 884 885 [@stdlib/assert/is-typed-array-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-typed-array-like 886 887 [@stdlib/assert/is-typed-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-typed-array 888 889 [@stdlib/assert/is-unity-probability-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-unity-probability-array 890 891 [@stdlib/assert/is-complex-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-complex-like 892 893 [@stdlib/assert/is-complex-typed-array-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-complex-typed-array-like 894 895 [@stdlib/assert/is-complex-typed-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-complex-typed-array 896 897 [@stdlib/assert/is-complex]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-complex 898 899 [@stdlib/assert/is-complex128]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-complex128 900 901 [@stdlib/assert/is-complex128array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-complex128array 902 903 [@stdlib/assert/is-complex64]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-complex64 904 905 [@stdlib/assert/is-complex64array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-complex64array 906 907 [@stdlib/assert/is-centrosymmetric-matrix]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-centrosymmetric-matrix 908 909 [@stdlib/assert/is-float32matrix-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-float32matrix-like 910 911 [@stdlib/assert/is-float32ndarray-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-float32ndarray-like 912 913 [@stdlib/assert/is-float32vector-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-float32vector-like 914 915 [@stdlib/assert/is-float64matrix-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-float64matrix-like 916 917 [@stdlib/assert/is-float64ndarray-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-float64ndarray-like 918 919 [@stdlib/assert/is-float64vector-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-float64vector-like 920 921 [@stdlib/assert/is-matrix-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-matrix-like 922 923 [@stdlib/assert/is-ndarray-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-ndarray-like 924 925 [@stdlib/assert/is-nonsymmetric-matrix]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonsymmetric-matrix 926 927 [@stdlib/assert/is-persymmetric-matrix]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-persymmetric-matrix 928 929 [@stdlib/assert/is-skew-centrosymmetric-matrix]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-skew-centrosymmetric-matrix 930 931 [@stdlib/assert/is-skew-persymmetric-matrix]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-skew-persymmetric-matrix 932 933 [@stdlib/assert/is-skew-symmetric-matrix]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-skew-symmetric-matrix 934 935 [@stdlib/assert/is-square-matrix]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-square-matrix 936 937 [@stdlib/assert/is-symmetric-matrix]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-symmetric-matrix 938 939 [@stdlib/assert/is-vector-like]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-vector-like 940 941 [@stdlib/assert/is-float32array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-float32array 942 943 [@stdlib/assert/is-float64array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-float64array 944 945 [@stdlib/assert/is-int16array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-int16array 946 947 [@stdlib/assert/is-int32array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-int32array 948 949 [@stdlib/assert/is-int8array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-int8array 950 951 [@stdlib/assert/is-uint16array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-uint16array 952 953 [@stdlib/assert/is-uint32array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-uint32array 954 955 [@stdlib/assert/is-uint8array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-uint8array 956 957 [@stdlib/assert/is-uint8clampedarray]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-uint8clampedarray 958 959 [@stdlib/assert/is-cube-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-cube-number 960 961 [@stdlib/assert/is-integer-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-integer-array 962 963 [@stdlib/assert/is-integer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-integer 964 965 [@stdlib/assert/is-negative-integer-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-negative-integer-array 966 967 [@stdlib/assert/is-negative-integer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-negative-integer 968 969 [@stdlib/assert/is-negative-number-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-negative-number-array 970 971 [@stdlib/assert/is-negative-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-negative-number 972 973 [@stdlib/assert/is-nonnegative-integer-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonnegative-integer-array 974 975 [@stdlib/assert/is-nonnegative-integer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonnegative-integer 976 977 [@stdlib/assert/is-nonnegative-number-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonnegative-number-array 978 979 [@stdlib/assert/is-nonnegative-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonnegative-number 980 981 [@stdlib/assert/is-nonpositive-integer-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonpositive-integer-array 982 983 [@stdlib/assert/is-nonpositive-integer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonpositive-integer 984 985 [@stdlib/assert/is-nonpositive-number-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonpositive-number-array 986 987 [@stdlib/assert/is-nonpositive-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nonpositive-number 988 989 [@stdlib/assert/is-positive-integer-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-positive-integer-array 990 991 [@stdlib/assert/is-positive-integer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-positive-integer 992 993 [@stdlib/assert/is-positive-number-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-positive-number-array 994 995 [@stdlib/assert/is-positive-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-positive-number 996 997 [@stdlib/assert/is-safe-integer-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-safe-integer-array 998 999 [@stdlib/assert/is-safe-integer]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-safe-integer 1000 1001 [@stdlib/assert/is-square-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-square-number 1002 1003 [@stdlib/assert/is-square-triangular-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-square-triangular-number 1004 1005 [@stdlib/assert/is-triangular-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-triangular-number 1006 1007 [@stdlib/assert/is-array-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-array-array 1008 1009 [@stdlib/assert/is-boolean-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-boolean-array 1010 1011 [@stdlib/assert/is-function-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-function-array 1012 1013 [@stdlib/assert/is-nan-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nan-array 1014 1015 [@stdlib/assert/is-null-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-null-array 1016 1017 [@stdlib/assert/is-number-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-number-array 1018 1019 [@stdlib/assert/is-object-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-object-array 1020 1021 [@stdlib/assert/is-string-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-string-array 1022 1023 [@stdlib/assert/is-symbol-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-symbol-array 1024 1025 [@stdlib/assert/is-array]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-array 1026 1027 [@stdlib/assert/is-boolean]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-boolean 1028 1029 [@stdlib/assert/is-date-object]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-date-object 1030 1031 [@stdlib/assert/is-function]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-function 1032 1033 [@stdlib/assert/is-nan]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-nan 1034 1035 [@stdlib/assert/is-null]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-null 1036 1037 [@stdlib/assert/is-number]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-number 1038 1039 [@stdlib/assert/is-object]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-object 1040 1041 [@stdlib/assert/is-regexp]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-regexp 1042 1043 [@stdlib/assert/is-string]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-string 1044 1045 [@stdlib/assert/is-symbol]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-symbol 1046 1047 [@stdlib/assert/is-undefined]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-undefined 1048 1049 <!-- </toc-links> --> 1050 1051 </section> 1052 1053 <!-- /.links -->