Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@bevry/json

bevry1kArtistic-2.02.4.0TypeScript support: included

Helpers for reading and writing JSON.

browser, deno, deno-edition, deno-entry, denoland, ecmascript, es2015, es2022, from, module, node, read, serialise, serialize, to, typed, types, typescript, write

readme

@bevry/json

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

Helpers for reading and writing JSON.

Usage

Complete API Documentation.

Install

npm

  • Install: npm install --save @bevry/json
  • Import: import * as pkg from ('@bevry/json')
  • Require: const pkg = require('@bevry/json')

Deno

import * as pkg from 'https://unpkg.com/@bevry/json@^2.4.0/edition-deno/index.ts'

Skypack

<script type="module">
    import * as pkg from '//cdn.skypack.dev/@bevry/json@^2.4.0'
</script>

unpkg

<script type="module">
    import * as pkg from '//unpkg.com/@bevry/json@^2.4.0'
</script>

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/@bevry/json@2.4.0'
</script>

Editions

This package is published with the following editions:

  • @bevry/json aliases @bevry/json/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
  • @bevry/json/source/index.ts is TypeScript source code with Import for modules
  • @bevry/json/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
  • @bevry/json/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • @bevry/json/edition-es2015/index.js is TypeScript compiled against ES2015 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • @bevry/json/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
  • @bevry/json/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
  • @bevry/json/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Sponsors

  • Andrew Nesbitt — Software engineer and researcher
  • Balsa — We're Balsa, and we're building tools for builders.
  • Codecov — Empower developers with tools to improve code quality and testing.
  • Poonacha Medappa
  • Rob Morris
  • Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
  • Syntax — Syntax Podcast

Donors

License

Unless stated otherwise all works are:

and licensed under:

changelog

History

v2.4.0 2023 December 29

v2.3.0 2023 December 27

v2.2.1 2023 December 22

v2.2.0 2023 December 6

v2.1.0 2023 November 25

v2.0.0 2023 November 23

  • Updated dependencies, base files, and editions using boundation
  • Minimum required Node.js version changed from node: >=10 to node: >=4 adapting to ecosystem changes

v1.10.0 2023 November 21

v1.9.0 2023 November 17

v1.8.0 2023 November 15

v1.7.0 2023 November 14

v1.6.0 2023 November 13

v1.5.0 2023 November 2

v1.4.0 2021 July 30

v1.3.0 2021 July 30

  • TypeScript generics so you can specify the type of data you are working with.
  • Uses @bevry/file internally to safely read and write the files, and provide detailed errors if such fails and why.
  • Add deleteJSON to delete a json file (doesn't actually care if it is indeed a json file, will delete the file regardless of its extension).
  • Dropped the encoding param, as utf8 is most convenient.

v1.2.0 2021 July 29

v1.1.0 2021 July 28

v1.0.0 2021 July 26

  • Initial working release