Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
buffer-json
Advanced tools
Readme
npm install buffer-json
const BJSON = require('buffer-json')
const str = BJSON.stringify({ buf: Buffer.from('hello') })
// => '{"buf":{"type":"Buffer","data":"base64:aGVsbG8="}}'
BJSON.parse(str)
// => { buf: <Buffer 68 65 6c 6c 6f> }
The Buffer
class in Node.js is used to represent binary data. JSON does not specify a way to encode binary data, so the Node.js implementation of JSON.stringify
represents buffers as an object of shape { type: "Buffer", data: [<bytes as numbers>] }
. Unfortunately, JSON.parse
does not turn this structure back into a Buffer
object:
$ node
> JSON.parse(JSON.stringify({ buf: Buffer.from('hello world') }))
{ buf:
{ type: 'Buffer',
data: [ 104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100 ] } }
JSON.stringify
and JSON.parse
accept arguments called replacer
and reviver
respectively which allow customizing the parsing/encoding behavior. This module provides a replacer which encodes Buffer data as a base64-encoded string, and a reviver which turns JSON objects which contain buffer-like data (either as arrays of numbers or strings) into Buffer
instances. All other types of values are parsed/encoded as normal.
stringify(value[, space])
Convenience wrapper for JSON.stringify
with the replacer
described below.
parse(text)
Convenience wrapper for JSON.parse
with the reviver
described below.
replacer(key, value)
A replacer
implementation which turns every value that is a Buffer
instance into an object of shape { type: 'Buffer', data: 'base64:<base64-encoded buffer content>' }
. Empty buffers are encoded as { type: 'Buffer', data: '' }
.
reviver(key, value)
A reviver
implementation which turns every object of shape { type: 'Buffer', data: <array of numbers or string> }
into a Buffer
instance.
buffer-json-encoding
: an abstract-encoding
compatible JSON encoder/decoder which uses this module.MIT
FAQs
JSON.stringify & JSON.parse which can encode/decode buffers.
The npm package buffer-json receives a total of 825,279 weekly downloads. As such, buffer-json popularity was classified as popular.
We found that buffer-json demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.