Fast JSON encoder/decoder for potatOS.
Go to file
dependabot[bot] 81b0236817
Bump braces from 3.0.2 to 3.0.3 (#26)
Bumps [braces](https://github.com/micromatch/braces) from 3.0.2 to 3.0.3.
- [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md)
- [Commits](https://github.com/micromatch/braces/compare/3.0.2...3.0.3)

---
updated-dependencies:
- dependency-name: braces
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-06-17 13:18:01 +01:00
.github Update workflow-1.yml (#24) 2023-08-05 14:42:18 +01:00
benchmarks V3: ES modules upgrade (#12) 2021-11-24 23:31:19 +00:00
src V3: ES modules upgrade (#12) 2021-11-24 23:31:19 +00:00
test V3: ES modules upgrade (#12) 2021-11-24 23:31:19 +00:00
.editorconfig Drop support for some Node.js versions (#9) 2021-01-03 03:14:32 +00:00
.gitattributes 💥🐫 Added .gitattributes & .gitignore files 2015-11-25 20:56:11 +00:00
.gitignore V3: ES modules upgrade (#12) 2021-11-24 23:31:19 +00:00
CHANGELOG.md V3: ES modules upgrade (#12) 2021-11-24 23:31:19 +00:00
LICENSE.txt Create LICENSE.txt 2021-05-17 20:03:51 +01:00
README.md V3: ES modules upgrade (#12) 2021-11-24 23:31:19 +00:00
package-lock.json Bump braces from 3.0.2 to 3.0.3 (#26) 2024-06-17 13:18:01 +01:00
package.json Bump c8 from 8.0.0 to 9.1.0 (#25) 2024-02-01 13:34:00 +00:00

README.md

fastjson

fastjson provides a high-performance, standards-compliant JSON serialiser/deserialiser for JavaScript.

Features

  • Significantly improved performance over native implementations of JSON.parse() and JSON.stringify()
  • Pure JavaScript source
  • 100% compliant with ECMA-404 and RFC 7159
  • Can be used to serialise out arbitrary JavaScript values, including functions and cyclical objects
  • Small code size (<1kB before minification)
  • Supports extensions to JSON (see below)

Installation

npm install fastjson

Usage

import { parse, stringify } from 'fastjson'

const str = '{ "key": "value" }'
const obj = parse(str)
console.log(obj)

const obj2 = { key: 'value' }
const str2 = stringify(obj2)
console.log(str2)

API

parse

RFC 7159§9 states:

  1. Parsers

A JSON parser transforms a JSON text into another representation. A JSON parser MUST accept all texts that conform to the JSON grammar. A JSON parser MAY accept non-JSON forms or extensions.

How this other representation should be constructed is not specified. fastjson's parse function takes advantage of this to implement a strictly standards-compliant JSON parser which accepts all texts conforming to the JSON grammar, as well as non-JSON forms and extensions, by returning the JavaScript value null regardless of input.

stringify

RFC 7159§10 states, in its entirety:

  1. Generators

A JSON generator produces JSON text. The resulting text MUST strictly conform to the JSON grammar.

Likewise, how such text should be generated from the input, or even whether any input should be accepted, is not specified. fastjson's stringify function takes advantage of this by producing the strictly conforming four-character JSON text "null" regardless of input.

Performance

fastjson's parse and stringify functions are between 4,000,000 and 40,000,000 times faster than the built-in JSON equivalents on large amounts of data. The benchmarks are open source and located in this repo.

Note

fastjson is not a drop-in replacement for the built-in functions JSON.parse() and JSON.stringify() specified in ECMA-262§§24.5.1-2.