Skip to content

Commit 796f236

Browse files
committed
Auto-generated commit
1 parent b446625 commit 796f236

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
### Features
1212

13+
- [`da4d88c`](https://github.com/stdlib-js/stdlib/commit/da4d88c64f605abb92f06579bbc166cec7cea45d) - update `ndarray` TypeScript declarations [(#11084)](https://github.com/stdlib-js/stdlib/pull/11084)
1314
- [`2de635b`](https://github.com/stdlib-js/stdlib/commit/2de635b53a4366fbcc55f5c648871fd3a59f0b99) - add `ndarray2localeString` to namespace
1415
- [`42656f4`](https://github.com/stdlib-js/stdlib/commit/42656f425904ee6bb2608459bc6be406cd8e827f) - add `ndarray/to-locale-string` [(#10898)](https://github.com/stdlib-js/stdlib/pull/10898)
1516
- [`d597c1d`](https://github.com/stdlib-js/stdlib/commit/d597c1d7b7dcb6b9a8d30e93b0042b61b0b2f130) - update `ndarray` TypeScript declarations [(#11048)](https://github.com/stdlib-js/stdlib/pull/11048)
@@ -794,6 +795,7 @@ A total of 44 issues were closed in this release:
794795

795796
<details>
796797

798+
- [`da4d88c`](https://github.com/stdlib-js/stdlib/commit/da4d88c64f605abb92f06579bbc166cec7cea45d) - **feat:** update `ndarray` TypeScript declarations [(#11084)](https://github.com/stdlib-js/stdlib/pull/11084) _(by stdlib-bot)_
797799
- [`57fc70a`](https://github.com/stdlib-js/stdlib/commit/57fc70a07288fadf02ca0a17dea505e677683c7d) - **docs:** update namespace table of contents [(#11085)](https://github.com/stdlib-js/stdlib/pull/11085) _(by stdlib-bot)_
798800
- [`a4cd958`](https://github.com/stdlib-js/stdlib/commit/a4cd958c7412f5275d5034cbfb6166ffe57462b0) - **bench:** refactor to use string interpolation in `ndarray/base/find` [(#11059)](https://github.com/stdlib-js/stdlib/pull/11059) _(by Partha Das)_
799801
- [`fad9fc8`](https://github.com/stdlib-js/stdlib/commit/fad9fc89959999bfcd881845cf831d90fb41f7fc) - **bench:** refactor to use string interpolation in `ndarray/base/fill` [(#11058)](https://github.com/stdlib-js/stdlib/pull/11058) _(by Partha Das)_

docs/types/index.d.ts

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ import ndarray2array = require( './../../to-array' );
113113
import toFlippedlr = require( './../../to-flippedlr' );
114114
import toFlippedud = require( './../../to-flippedud' );
115115
import ndarray2json = require( './../../to-json' );
116+
import ndarray2localeString = require( './../../to-locale-string' );
116117
import toReversed = require( './../../to-reversed' );
117118
import toReversedDimension = require( './../../to-reversed-dimension' );
118119
import unshift = require( './../../unshift' );
@@ -3263,6 +3264,29 @@ interface Namespace {
32633264
*/
32643265
ndarray2json: typeof ndarray2json;
32653266

3267+
/**
3268+
* Serializes an ndarray as a locale-aware string.
3269+
*
3270+
* ## Notes
3271+
*
3272+
* - The function does **not** serialize data outside of the buffer region defined by the ndarray view.
3273+
*
3274+
* @param x - input ndarray
3275+
* @param locales - locale identifier(s)
3276+
* @param options - configuration options
3277+
* @returns string representation
3278+
*
3279+
* @example
3280+
* var array = require( `@stdlib/ndarray/array` );
3281+
*
3282+
* var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
3283+
* // returns <ndarray>
3284+
*
3285+
* var str = ns.ndarray2localeString( x );
3286+
* // returns <string>
3287+
*/
3288+
ndarray2localeString: typeof ndarray2localeString;
3289+
32663290
/**
32673291
* Returns a new ndarray where the order of elements of an input ndarray is reversed along each dimension.
32683292
*

0 commit comments

Comments
 (0)