Skip to content

Commit

Permalink
feat: update namespace TypeScript declarations
Browse files Browse the repository at this point in the history
PR-URL: #3977
Reviewed-by: Athan Reines <[email protected]>
Signed-off-by: stdlib-bot <[email protected]>
Co-authored-by: Philipp Burckhardt <[email protected]>
  • Loading branch information
stdlib-bot and Planeshifter authored Dec 17, 2024
1 parent 54fb9de commit 323e4e5
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions lib/node_modules/@stdlib/ndarray/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ import stride = require( '@stdlib/ndarray/stride' );
import strides = require( '@stdlib/ndarray/strides' );
import sub2ind = require( '@stdlib/ndarray/sub2ind' );
import ndarray2array = require( '@stdlib/ndarray/to-array' );
import ndarray2json = require( '@stdlib/ndarray/to-json' );
import zeros = require( '@stdlib/ndarray/zeros' );
import zerosLike = require( '@stdlib/ndarray/zeros-like' );

Expand Down Expand Up @@ -1599,6 +1600,27 @@ interface Namespace {
*/
ndarray2array: typeof ndarray2array;

/**
* Serializes an ndarray as a JSON object.
*
* ## Notes
*
* - The function does **not** serialize data outside of the buffer region defined by the ndarray view.
*
* @param x - input ndarray
* @returns JSON object
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
* // returns <ndarray>
*
* var o = ns.ndarray2json( x );
* // returns {...}
*/
ndarray2json: typeof ndarray2json;

/**
* Creates a zero-filled array having a specified shape and data type.
*
Expand Down

1 comment on commit 323e4e5

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
ndarray $\color{green}546/546$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}546/546$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.