Skip to content

docs: update ndarray TypeScript declarations #11132

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
Mar 25, 2026
Merged

docs: update ndarray TypeScript declarations #11132

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
23 changes: 14 additions & 9 deletions lib/node_modules/@stdlib/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3410,13 +3410,16 @@ interface Namespace {
* @returns zero-filled array
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var arr = ns.zeros( [ 2, 2 ] );
* // returns <ndarray>
* // returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
*
* var sh = arr.shape;
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* var dt = arr.dtype;
* var dt = String( getDType( arr ) );
* // returns 'float64'
*/
zeros: typeof zeros;
Expand All @@ -3435,26 +3438,28 @@ interface Namespace {
* @returns zero-filled array
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = zeros( [ 2, 2 ], {
* 'dtype': 'float64'
* });
* // returns <ndarray>
* // returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
*
* var sh = x.shape;
* var sh = getShape( x );
* // returns [ 2, 2 ]
*
* var dt = x.dtype;
* var dt = String( getDType( x ) );
* // returns 'float64'
*
* var y = ns.zerosLike( x );
* // returns <ndarray>
* // returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
*
* sh = y.shape;
* sh = getShape( y );
* // returns [ 2, 2 ]
*
* dt = y.dtype;
* dt = String( getDType( y ) );
* // returns 'float64'
*/
zerosLike: typeof zerosLike;
Expand Down