feat: update ndarray/base/assert TypeScript declarations

Planeshifter · Planeshifter · commit e24d1a701a3c · 2025-12-02T10:52:29.000-06:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
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
@@ -31,6 +31,7 @@ import isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major' );
 import isColumnMajorContiguous = require( '@stdlib/ndarray/base/assert/is-column-major-contiguous' );
 import isColumnMajorString = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
 import isComplexFloatingPointDataType = require( '@stdlib/ndarray/base/assert/is-complex-floating-point-data-type' );
+import isComplexFloatingPointDataTypeChar = require( '@stdlib/ndarray/base/assert/is-complex-floating-point-data-type-char' );
 import isContiguous = require( '@stdlib/ndarray/base/assert/is-contiguous' );
 import isDataType = require( '@stdlib/ndarray/base/assert/is-data-type' );
 import isDataTypeObject = require( '@stdlib/ndarray/base/assert/is-data-type-object' );
@@ -389,6 +390,57 @@ interface Namespace {
 	*/
 	isComplexFloatingPointDataType: typeof isComplexFloatingPointDataType;
 
+	/**
+	* Tests whether an input value is a supported ndarray complex-valued floating-point data type single letter character abbreviation.
+	*
+	* @param v - value to test
+	* @returns boolean indicating whether an input value is a supported ndarray complex-valued floating-point data type single letter character abbreviation
+	*
+	* @example
+	* var bool = ns.isComplexFloatingPointDataTypeChar( 'r' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'c' );
+	* // returns true
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'z' );
+	* // returns true
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'f' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'd' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'o' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'k' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'i' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 's' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 't' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'u' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'b' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'a' );
+	* // returns false
+	*
+	* bool = ns.isComplexFloatingPointDataTypeChar( 'foo' );
+	* // returns false
+	*/
+	isComplexFloatingPointDataTypeChar: typeof isComplexFloatingPointDataTypeChar;
+
 	/**
 	* Returns a boolean indicating if an array is contiguous.
 	*
