# ndarray2localeString
> Serialize an [ndarray][@stdlib/ndarray/ctor] as a locale-aware string.
## Usage
```javascript
var ndarray2localeString = require( '@stdlib/ndarray/to-locale-string' );
```
#### ndarray2localeString( x\[, locales\[, options]] )
Serializes an [ndarray][@stdlib/ndarray/ctor] as a locale-aware string.
```javascript
var array = require( '@stdlib/ndarray/array' );
var x = array( [ 1, 2, 3, 4 ], {
'shape': [ 2, 2 ]
});
// returns
var str = ndarray2localeString( x );
// returns
```
The function supports the following parameters:
- **x**: input ndarray.
- **locales**: a [BCP 47][bcp-47] language tag or an array of such strings (_optional_).
- **options**: configuration options (_optional_).
## Notes
- The function does **not** serialize data outside of the buffer region defined by the [ndarray][@stdlib/ndarray/ctor] view.
- For ndarrays with more than `100` elements, the function abbreviates the data, showing only the first three and last three values.
## Examples
```javascript
var array = require( '@stdlib/ndarray/array' );
var ndarray2localeString = require( '@stdlib/ndarray/to-locale-string' );
// Create a 2x3 ndarray:
var x = array( [ 1234.567, 9876.543, 1111.222, 3333.444, 5555.666, 7777.888 ], {
'shape': [ 2, 3 ],
'dtype': 'generic'
});
// Serialize using the default locale:
var str = ndarray2localeString( x );
// e.g., returns 'ndarray( \'generic\', [ 1,234.567, 9,876.543, 1,111.222, 3,333.444, 5,555.666, 7,777.888 ], [ 2, 3 ], [ 3, 1 ], 0, \'row-major\' )'
// Serialize using the English (US) locale:
str = ndarray2localeString( x, 'en-US' );
// returns 'ndarray( \'generic\', [ 1,234.567, 9,876.543, 1,111.222, 3,333.444, 5,555.666, 7,777.888 ], [ 2, 3 ], [ 3, 1 ], 0, \'row-major\' )'
// Serialize using the German locale:
str = ndarray2localeString( x, 'de-DE' );
// returns 'ndarray( \'generic\', [ 1.234,567, 9.876,543, 1.111,222, 3.333,444, 5.555,666, 7.777,888 ], [ 2, 3 ], [ 3, 1 ], 0, \'row-major\' )'
// Serialize with a maximum number of fraction digits:
str = ndarray2localeString( x, 'en-US', {
'maximumFractionDigits': 0
});
// returns 'ndarray( \'generic\', [ 1,235, 9,877, 1,111, 3,333, 5,556, 7,778 ], [ 2, 3 ], [ 3, 1 ], 0, \'row-major\' )'
```
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
[bcp-47]: https://tools.ietf.org/html/rfc5646