Skip to content

docs: update assert TypeScript declaration examples #12270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
May 25, 2026
Merged

docs: update assert TypeScript declaration examples #12270

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions lib/node_modules/@stdlib/assert/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2755,10 +2755,11 @@ interface Namespace {
* @returns boolean indicating if a value is a 2-dimensional ndarray-like object whose underlying data type is `complex128`
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
* var arr = zeros( [ 2, 2 ], {
* 'dtype': 'complex128'
* });
*
* var bool = ns.isComplex128MatrixLike( arr );
* // returns true
Expand All @@ -2775,10 +2776,11 @@ interface Namespace {
* @returns boolean indicating if a value is an ndarray-like object whose underlying data type is `complex128`
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
* var arr = zeros( [ 2, 2 ], {
* 'dtype': 'complex128'
* });
*
* var bool = ns.isComplex128ndarrayLike( arr );
* // returns true
Expand All @@ -2795,10 +2797,11 @@ interface Namespace {
* @returns boolean indicating if a value is a 1-dimensional ndarray-like object whose underlying data type is `complex128`
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 4 ], [ 1 ], 0, 'row-major' );
* var arr = zeros( [ 4 ], {
* 'dtype': 'complex128'
* });
*
* var bool = ns.isComplex128VectorLike( arr );
* // returns true
Expand Down