@stdlib/complex-reviver

Reviver

Revive a JSON-serialized complex number.

Installation

npm install @stdlib/complex-reviver

Usage

var reviver = require( '@stdlib/complex-reviver' );

reviver( key, value )

Revives a JSON-serialized complex number.

var parseJSON = require( '@stdlib/utils-parse-json' );

var str = '{"type":"Complex128","re":5,"im":3}';

var z = parseJSON( str, reviver );
// returns <Complex128>

For details on the JSON serialization format, see Complex128.

Examples

var Complex128 = require( '@stdlib/complex-float64' );
var parseJSON = require( '@stdlib/utils-parse-json' );
var reviver = require( '@stdlib/complex-reviver' );

var z = new Complex128( 5.0, 3.0 );
var str = JSON.stringify( z );
// returns '{"type":"Complex128","re":5,"im":3}'

var w = parseJSON( str, reviver );
if ( w instanceof Error ) {
    throw w;
}
var bool = ( w instanceof z.constructor );
// returns true

bool = ( w.re === z.re );
// returns true

bool = ( w.im === z.im );
// returns true

---

See Also

• @stdlib/complex/float64: 128-bit complex number.
• @stdlib/complex/float32: 64-bit complex number.
• @stdlib/complex/reviver-float64: revive a JSON-serialized 128-bit complex number.
• @stdlib/complex/reviver-float32: revive a JSON-serialized 64-bit complex number.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, 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-2022. The Stdlib Authors.