diff --git a/lib/node_modules/@stdlib/assert/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/docs/types/index.d.ts index c13ac7da6f30..daaa73cc5cdb 100644 --- a/lib/node_modules/@stdlib/assert/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/docs/types/index.d.ts @@ -221,6 +221,7 @@ import isNamedTypedTupleLike = require( '@stdlib/assert/is-named-typed-tuple-lik import isnan = require( '@stdlib/assert/is-nan' ); import isNaNArray = require( '@stdlib/assert/is-nan-array' ); import isNativeFunction = require( '@stdlib/assert/is-native-function' ); +import isndarrayDescriptor = require( '@stdlib/assert/is-ndarray-descriptor' ); import isndarrayLike = require( '@stdlib/assert/is-ndarray-like' ); import isndarrayLikeWithDataType = require( '@stdlib/assert/is-ndarray-like-with-data-type' ); import isNegativeFinite = require( '@stdlib/assert/is-negative-finite' ); @@ -4735,6 +4736,34 @@ interface Namespace { */ isNativeFunction: typeof isNativeFunction; + /** + * Tests if a value is an ndarray descriptor. + * + * ## Notes + * + * - An ndarray descriptor is an object with the following properties: + * + * - dtype: data type. + * - data: underlying data buffer. + * - shape: array shape. + * - strides: array strides. + * - offset: starting index of the first indexed element in the data buffer. + * - order: storage layout. + * + * @param v - value to test + * @returns boolean indicating if a value is an ndarray descriptor + * + * @example + * var zeros = require( '@stdlib/ndarray/zeros' ); + * + * var bool = ns.isndarrayDescriptor( zeros( [ 2, 2 ] ) ); + * // returns true + * + * bool = ns.isndarrayDescriptor( [] ); + * // returns false + */ + isndarrayDescriptor: typeof isndarrayDescriptor; + /** * Tests if a value is ndarray-like. *