JSON with BigInt

JS library that allows you to easily serialize and deserialize data with BigInt values

Why would I need JSON-with-BigInt?

3 reasons:

You need to convert some data to/from JSON and it includes BigInt values
Native JSON.stringify() and JSON.parse() methods in JS can't work with BigInt
Other libraries and pieces of code that you'll find either can't solve this problem while supporting consistent round-trip operations (meaning, you will not get the same BigInt values if you serialize and then deserialize them) or requires you to change your JSON or the way you want to work with your data

Good things about JSON-with-BigInt

✔️ Supports consistent round-trip operations with JSON

const data = { bigNumber: 9007199254740992n };
JSONStringify(data) // '{"bigNumber":9007199254740992}'
JSONParse(JSONStringify(data)).bigNumber === 9007199254740992n // true

✔️ No need to change your JSON or the way you want to work with your data

✔️ Parses and stringifies all other values other than big numbers the same way as native JSON methods in JS do

✔️ Correctly parses float numbers and negative numbers

✔️ Correctly parses pretty printed JSON (formatted with newline and whitespace characters)

✔️ Does not contaminate your global space (unlike monkey-patching solution)

✔️ You don't have to memorize this library's API, you already know it. Just skip the dot, use camelCase and that's it (JSONParse(), JSONStringify())

✔️ Can be used in both JavaScript and TypeScript projects (.d.ts file included)

✔️ Size: 762 bytes (minified and gzipped)

✔️ No dependencies

Getting Started

This library has no default export. Why it's a good thing

NPM

Add this library to your project using NPM

npm i json-with-bigint

and use it

import { JSONParse, JSONStringify } from 'json-with-bigint';

const userData = {
  someBigNumber: 9007199254740992n
};

localStorage.setItem('userData', JSONStringify(userData));

const restoredUserData = JSONParse(localStorage.getItem('userData') || '');

CDN

Add this code to your HTML

<script src="https://cdn.jsdelivr.net/npm/json-with-bigint/json-with-bigint.min.js"></script>

and use it

<script>
  const userData = {
    someBigNumber: 9007199254740992n
  };

  localStorage.setItem('userData', JSONStringify(userData));

  const restoredUserData = JSONParse(localStorage.getItem('userData') || '');
</script>

Manually

Download json-with-bigint.min.js from this repository to your project's folder and use it

<script src="./json-with-bigint.min.js"></script>
<script>
  const userData = {
    someBigNumber: 9007199254740992n
  };

  localStorage.setItem('userData', JSONStringify(userData));

  const restoredUserData = JSONParse(localStorage.getItem('userData') || '');
</script>

How to use

JSONParse - works just like native JSON.parse, but supports BigInt

JSONStringify - works just like native JSON.stringify, but supports BigInt

Examples:

JSONParse('{"someBigNumber":9007199254740992}')
JSONStringify({ someBigNumber: 9007199254740992n })

License

bichinger/json-with-bigint

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages