README.md

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

typedarray2json

Return a JSON representation of a typed array.

Usage

import typedarray2json from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-to-json@deno/mod.js';

typedarray2json( typedarray )

Returns a JSON representation of a typed array.

import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';

var arr = new Float64Array( [ 5.0, 3.0 ] );

var json = typedarray2json( arr );
/* returns
    {
        'type': 'Float64Array',
        'data': [ 5.0, 3.0 ]
    }
*/

For guidance on reviving a JSON-serialized typed array, see reviver().

Notes

• Supported typed array types:

  • Float64Array
  • Float32Array
  • Complex128Array
  • Complex64Array
  • BooleanArray
  • Int32Array
  • Uint32Array
  • Int16Array
  • Uint16Array
  • Int8Array
  • Uint8Array
  • Uint8ClampedArray

• The implementation provides basic support for custom typed arrays and sets the type field to the closest known typed array type.

  class CustomArray extends Float64Array() {
      constructor( data ) {
          super( data );
      }
  }
  
  var arr = new CustomArray( [ 5.0, 3.0 ] );
  
  var json = typedarray2json( arr );
  /* returns
      {
          'type': 'Float64Array',
          'data': [ 5.0, 3.0 ]
      }
  */

Examples

import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';
import Float32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float32@deno/mod.js';
import Int32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-int32@deno/mod.js';
import Uint32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-uint32@deno/mod.js';
import Int16Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-int16@deno/mod.js';
import Uint16Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-uint16@deno/mod.js';
import Int8Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-int8@deno/mod.js';
import Uint8Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-uint8@deno/mod.js';
import Uint8ClampedArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-uint8c@deno/mod.js';
import Complex64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-complex64@deno/mod.js';
import Complex128Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-complex128@deno/mod.js';
import BooleanArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-bool@deno/mod.js';
import typedarray2json from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-to-json@deno/mod.js';

var arr = new Float64Array( [ 5.0, 3.0 ] );
var json = typedarray2json( arr );
/* returns
    {
        'type': 'Float64Array',
        'data': [ 5.0, 3.0 ]
    }
*/

arr = new Float32Array( [ 5.0, -3.0 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Float32Array',
        'data': [ 5.0, -3.0 ]
    }
*/

arr = new Complex128Array( [ 5.0, 3.0 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Complex128Array',
        'data': [ 5.0, 3.0 ]
    }
*/

arr = new Complex64Array( [ 5.0, 3.0 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Complex64Array',
        'data': [ 5.0, 3.0 ]
    }
*/

arr = new BooleanArray( [ true, false ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'BooleanArray',
        'data': [ 1, 0 ]
    }
*/

arr = new Int32Array( [ -5, 3 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Int32Array',
        'data': [ -5, 3 ]
    }
*/

arr = new Uint32Array( [ 5, 3 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Uint32Array',
        'data': [ 5, 3 ]
    }
*/

arr = new Int16Array( [ -5, 3 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Int16Array',
        'data': [ -5, 3 ]
    }
*/

arr = new Uint16Array( [ 5, 3 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Uint16Array',
        'data': [ 5, 3 ]
    }
*/

arr = new Int8Array( [ -5, 3 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Int8Array',
        'data': [ -5, 3 ]
    }
*/

arr = new Uint8Array( [ 5, 3 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Uint8Array',
        'data': [ 5, 3 ]
    }
*/

arr = new Uint8ClampedArray( [ 5, 3 ] );
json = typedarray2json( arr );
/* returns
    {
        'type': 'Uint8ClampedArray',
        'data': [ 5, 3 ]
    }
*/

---

See Also

• @stdlib/array-reviver: revive a JSON-serialized typed array.

---

Notice

This package is part of stdlib, a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.