buffer-json

v2.0.0

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

NPM

README

GitHub

MIT

Latest version published 3 years ago

    npm install buffer-json

Explore Similar Packages

Package Health Score

65 / 100

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

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Secure Your Project

Find & fix vulnerable dependencies and insecure code

Popularity

Influential project

Weekly Downloads (1,439,181)

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

Direct Usage Popularity

The npm package buffer-json receives a total of 1,439,181 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 in 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

Popular

Version

Release Date

1.0.0

06/2015

2.0.0

02/2019

Direct Vulnerabilities

1.0.0

Popular

2.0.0

Indirect Vulnerabilities

1.0.0

Popular

2.0.0

License Risk

1.0.0

Popular

2.0.0

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

License

MIT

Security Policy

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

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

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

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 0
Last Release: 3 years ago
Last Commit: 3 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

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: 7 years
Dependencies: 0 Direct
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.

Not sure how to use buffer-json?

To help you get started, we've collected the most common ways that buffer-json is being used within popular public projects.

dcloudio / uni-app / packages / vue-cli-plugin-uni / lib / cache-loader.js View on Github

function write (key, data, callback) {
  const dirname = path.dirname(key)
  // template,缓存 mp template
  if (
    data.remainingRequest.indexOf('vue&type=template') !== -1 &&
    process.UNI_CACHE_TEMPLATES
  ) {
    data['mpTemplates'] = process.UNI_CACHE_TEMPLATES
    delete process.UNI_CACHE_TEMPLATES
  }

  const content = BJSON.stringify(data)

  if (directories.has(dirname)) {
    // for performance skip creating directory
    fs.writeFile(key, content, 'utf-8', callback)
  } else {
    mkdirp(dirname, (mkdirErr) => {
      if (mkdirErr) {
        callback(mkdirErr)
        return
      }

      directories.add(dirname)

      fs.writeFile(key, content, 'utf-8', callback)
    })
  }
}

View more ways to use buffer-json

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

FAQs

What is buffer-json?

JSON.stringify & JSON.parse which can encode/decode buffers. Visit Snyk Advisor to see a full health score report for buffer-json, including popularity, security, maintenance & community analysis.

Is buffer-json popular?

The npm package buffer-json receives a total of 1,439,181 weekly downloads. As such, buffer-json popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is buffer-json well maintained?

We found indications that buffer-json is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is buffer-json safe to use?

The npm package buffer-json was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 January-2022, at 18:58 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Secure Your Project

Weekly Downloads (1,439,181)

Direct Usage Popularity

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risk

Commit Frequency

Embed Package Health Score Badge

Not sure how to use buffer-json?

buffer-json

API

stringify(value[, space])

parse(text)

replacer(key, value)

reviver(key, value)

Related modules

License

FAQs

What is buffer-json?

Is buffer-json popular?

Is buffer-json well maintained?

Is buffer-json safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`stringify(value[, space])`

`parse(text)`

`replacer(key, value)`

`reviver(key, value)`