From b7e8b093d0ca429666b324fa92aa9784beb4716e Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Thu, 25 Jun 2026 03:19:28 +0000 Subject: [PATCH] feat: update `ndarray/base/assert` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../ndarray/base/assert/docs/types/index.d.ts | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) diff --git a/lib/node_modules/@stdlib/ndarray/base/assert/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/base/assert/docs/types/index.d.ts index deda89e4ff4a..9291c6fc655b 100644 --- a/lib/node_modules/@stdlib/ndarray/base/assert/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/base/assert/docs/types/index.d.ts @@ -22,6 +22,7 @@ import hasEqualShape = require( '@stdlib/ndarray/base/assert/has-equal-shape' ); import isAllowedDataTypeCast = require( '@stdlib/ndarray/base/assert/is-allowed-data-type-cast' ); +import isBinaryDataType = require( '@stdlib/ndarray/base/assert/is-binary-data-type' ); import isBooleanDataType = require( '@stdlib/ndarray/base/assert/is-boolean-data-type' ); import isBooleanIndexDataType = require( '@stdlib/ndarray/base/assert/is-boolean-index-data-type' ); import isBufferLengthCompatible = require( '@stdlib/ndarray/base/assert/is-buffer-length-compatible' ); @@ -38,6 +39,7 @@ import isDataTypeObject = require( '@stdlib/ndarray/base/assert/is-data-type-obj import isDataTypeString = require( '@stdlib/ndarray/base/assert/is-data-type-string' ); import isEqualDataType = require( '@stdlib/ndarray/base/assert/is-equal-data-type' ); import isFloatingPointDataType = require( '@stdlib/ndarray/base/assert/is-floating-point-data-type' ); +import isGenericDataType = require( '@stdlib/ndarray/base/assert/is-generic-data-type' ); import isIndexDataType = require( '@stdlib/ndarray/base/assert/is-index-data-type' ); import isIndexMode = require( '@stdlib/ndarray/base/assert/is-index-mode' ); import isInputCastingPolicy = require( '@stdlib/ndarray/base/assert/is-input-casting-policy' ); @@ -101,6 +103,54 @@ interface Namespace { */ isAllowedDataTypeCast: typeof isAllowedDataTypeCast; + /** + * Tests whether an input value is a supported ndarray binary data type. + * + * @param v - value to test + * @returns boolean indicating whether an input value is a supported ndarray binary data type + * + * @example + * var bool = ns.isBinaryDataType( 'binary' ); + * // returns true + * + * bool = ns.isBinaryDataType( 'bool' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'float32' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'float64' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'generic' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'int16' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'int32' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'int8' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'uint16' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'uint32' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'uint8' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'uint8c' ); + * // returns false + * + * bool = ns.isBinaryDataType( 'foo' ); + * // returns false + */ + isBinaryDataType: typeof isBinaryDataType; + /** * Tests whether an input value is a supported ndarray boolean data type. * @@ -663,6 +713,54 @@ interface Namespace { */ isFloatingPointDataType: typeof isFloatingPointDataType; + /** + * Tests whether an input value is a supported ndarray generic data type. + * + * @param v - value to test + * @returns boolean indicating whether an input value is a supported ndarray generic data type + * + * @example + * var bool = ns.isGenericDataType( 'binary' ); + * // returns false + * + * bool = ns.isGenericDataType( 'bool' ); + * // returns false + * + * bool = ns.isGenericDataType( 'float32' ); + * // returns false + * + * bool = ns.isGenericDataType( 'float64' ); + * // returns false + * + * bool = ns.isGenericDataType( 'generic' ); + * // returns true + * + * bool = ns.isGenericDataType( 'int16' ); + * // returns false + * + * bool = ns.isGenericDataType( 'int32' ); + * // returns false + * + * bool = ns.isGenericDataType( 'int8' ); + * // returns false + * + * bool = ns.isGenericDataType( 'uint16' ); + * // returns false + * + * bool = ns.isGenericDataType( 'uint32' ); + * // returns false + * + * bool = ns.isGenericDataType( 'uint8' ); + * // returns false + * + * bool = ns.isGenericDataType( 'uint8c' ); + * // returns false + * + * bool = ns.isGenericDataType( 'foo' ); + * // returns false + */ + isGenericDataType: typeof isGenericDataType; + /** * Tests whether an input value is a supported ndarray index data type. *