time-to-botec/squiggle/node_modules/@stdlib/buffer/reviver/README.md

Reviver

Revive a JSON-serialized Buffer.

Usage

var reviver = require( '@stdlib/buffer/reviver' );

reviver( key, value )

Revives a JSON-serialized Buffer.

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

var str = '{"type":"Buffer","data":[5,3]}';

var buf = parseJSON( str, reviver );
// returns <Buffer>[ 5, 3 ]

For details on the JSON serialization format, see toJSON().

Examples

var array2buffer = require( '@stdlib/buffer/from-array' );
var parseJSON = require( '@stdlib/utils/parse-json' );
var toJSON = require( '@stdlib/buffer/to-json' );
var reviver = require( '@stdlib/buffer/reviver' );

var buf = array2buffer( [ 1, 2 ] );
var str = JSON.stringify( toJSON( buf ) );
console.log( str );
// => '{"type":"Buffer","data":[1,2]}'

var out = parseJSON( str, reviver );
if ( out instanceof Error ) {
    throw out;
}
console.log( out );
// => <Buffer>[ 1, 2 ]