time-to-botec/squiggle/node_modules/@stdlib/array/to-json/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

46 lines
947 B
Plaintext

{{alias}}( arr )
Returns a JSON representation of a typed array.
The following typed array types are supported:
- Float64Array
- Float32Array
- Int32Array
- Uint32Array
- Int16Array
- Uint16Array
- Int8Array
- Uint8Array
- Uint8ClampedArray
The returned JSON object has the following properties:
- type: typed array type
- data: typed array data as a generic array
The implementation supports custom typed arrays and sets the `type` field to
the closest known typed array type.
Parameters
----------
arr: TypedArray
Typed array to serialize.
Returns
-------
out: Object
JSON representation.
Examples
--------
> var arr = new {{alias:@stdlib/array/float64}}( 2 );
> arr[ 0 ] = 5.0;
> arr[ 1 ] = 3.0;
> var json = {{alias}}( arr )
{ 'type': 'Float64Array', 'data': [ 5.0, 3.0 ] }
See Also
--------