@stdlib/buffer-reviver NPM

reviveBuffer

Revive a JSON-serialized Buffer.

Installation

npm install @stdlib/buffer-reviver

Usage

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

reviveBuffer( 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, reviveBuffer );
// returns <Buffer>[ 5, 3 ]

For details on the JSON serialization format, see @stdlib/buffer-to-json.

Examples

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

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

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

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.