Skip to content

Commit 42e586e

Browse files
docs: add documentation for toLocaleString method
1 parent 2833fcd commit 42e586e

File tree

1 file changed

+20
-0
lines changed
  • lib/node_modules/@stdlib/array/fixed-endian-factory

1 file changed

+20
-0
lines changed

lib/node_modules/@stdlib/array/fixed-endian-factory/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -908,6 +908,26 @@ var str = arr.join( 0 );
908908
// returns '10203'
909909
```
910910

911+
<a name="method-to-locale-string"></a>
912+
913+
#### TypedArrayFE.prototype.toLocaleString( \[locales\[, options]] )
914+
915+
Serializes an array as a locale-specific string.
916+
917+
```javascript
918+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
919+
920+
var arr = new Float64ArrayFE( 'little-endian', [ 2000, 500, 8123, 12, 4212 ] );
921+
922+
var str = arr.toLocaleString( 'en-US' );
923+
// returns '2,000,500,8,123,12,4,212'
924+
```
925+
926+
The method supports the following arguments:
927+
928+
- **locales**: a string with a BCP 47 language tag or an array of such strings.
929+
- **options**: configuration properties.
930+
911931
</section>
912932

913933
<!-- /.usage -->

0 commit comments

Comments
 (0)