buffer-json

v2.0.0

JSON.stringify & JSON.parse which can encode/decode buffers.

NPM

README

GitHub

Website

MIT

Latest version published 2 years ago

    npm install buffer-json

Explore Similar Packages

json 57 / 100

Package Health Score

55 / 100

Popularity
Influential project
Maintenance
Inactive
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Influential project

Weekly Downloads (1,137,541)

Dependents: 38
GitHub Stars: 11
Forks: 3
Contributors: 2

The npm package buffer-json receives a total of 1,137,541 downloads a week. As such, we scored buffer-json popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package buffer-json, we found that it has been starred 11 times, and that 38 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

1.0.0

2.0.0

Indirect Vulnerabilities

1.0.0

2.0.0

License Risks

1.0.0

2.0.0

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like buffer-json is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test buffer-json

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Merged PR: 1
Open PR: 0
Last Commit: 2 years ago

Further analysis of the maintenance status of buffer-json based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for buffer-json is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: No
License: MIT

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like buffer-json is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 0 Direct / 0 Total
Versions: 3
Install Size: 4.93 kB
Dist-tags: 1
# of Files: 4
Maintainers: 1
TS Typings: Yes

buffer-json has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

buffer-json

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.

API

`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.

Related modules

buffer-json-encoding: an abstract-encoding compatible JSON encoder/decoder which uses this module.

License

MIT

buffer-json versions

Dist-Tags for buffer-json

latest

Version	Published	Tag	Node.js Compatability	Licenses	Dependencies	Direct Vulnerabilities	Publisher
2.0.0	25 February 2019	latest	*	MIT	0	0 H 0 M 0 L	jprichardson
1.0.0	18 June 2015		*	MIT	0	0 H 0 M 0 L	jprichardson
All Versions

Last updated on 16 January-2021, at 05:21 (UTC).

buffer-json

JSON.stringify & JSON.parse which can encode/decode buffers.

Explore Similar Packages

Package Health Score

Popularity

Security

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risks

Maintenance

Community

Embed Package Health Score Badge

Package

buffer-json

API

`stringify(value[, space])`

`parse(text)`

`replacer(key, value)`

`reviver(key, value)`

Related modules

License

buffer-json versions

buffer-json dependencies