json-buffer

What is json-buffer?

The json-buffer npm package is designed to serialize and deserialize JSON data that includes binary Buffers. Normally, JSON.stringify() will lose the Buffer information, converting Buffers to objects. json-buffer preserves the Buffer data by encoding it as a base64 string when serializing and then decoding it back to a Buffer when deserializing.

What are json-buffer's main functionalities?

Serialization

Converts a JavaScript object with Buffers into a JSON string, encoding Buffers as base64 strings.

{"data":"VGhpcyBpcyBhIHRlc3QgYnVmZmVy"}

Deserialization

Parses a JSON string that contains base64 encoded Buffers, converting them back into Buffer objects.

{"type":"Buffer","data":[84,104,105,115,32,105,115,32,97,32,116,101,115,116,32,98,117,102,102,101,114]}

Other packages similar to json-buffer

buffer-json

buffer-json is similar to json-buffer in that it allows for serialization and deserialization of Buffer objects within JSON data. It differs in the way it encodes and decodes the Buffers, potentially using a different approach or algorithm.

README

json-buffer

JSON functions that can convert buffers!

JSON mangles buffers by converting to an array... which isn't helpful. json-buffers converts to base64 instead, and deconverts base64 to a buffer.

var JSONB = require('json-buffer')
var Buffer = require('buffer').Buffer

var str = JSONB.stringify(Buffer.from('hello there!'))

console.log(JSONB.parse(str)) //GET a BUFFER back

License

MIT