fast-stringify

A blazing fast stringifier that safely handles circular objects

Table of contents

• Usage
  • stringify
• Benchmarks
  • Simple objects
  • Complex objects
  • Circular objects
  • Special objects
• Development

Usage

import stringify from "fast-stringify";

const object = {
  foo: "bar",
  deeply: {
    recursive: {
      object: {}
    }
  }
};

object.deeply.recursive.object = object;

console.log(stringify(object));
// {"foo":"bar","deeply":{"recursive":{"object":"[ref-0]"}}}

stringify

stringify(object: any, replacer: ?function, indent: ?number, circularReplacer: ?function): string

Stringifies the object passed based on the parameters you pass. The only required value is the object. The additional parameters passed will customize how the string is compiled.

• replacer => function to customize how the value for each key is stringified (see the documentation for JSON.stringify for more details)
• indent => number of spaces to indent the stringified object for pretty-printing (see the documentation for JSON.stringify for more details)
• circularReplacer => function to customize how the circular reference is stringified (defaults to [ref-##] where ## is the reference count)

Benchmarks

Simple objects

Small number of properties, all values are primitives

Complex objects

Large number of properties, values are a combination of primitives and complex objects

Circular objects

Objects that deeply reference themselves

Special objects

Custom constructors, React components, etc

Development

Standard practice, clone the repo and npm i to get the dependencies. The following npm scripts are available:

• benchmark => run benchmark tests against other equality libraries
• build => build dist files with rollup
• clean => run clean:dist, clean:es, and clean:lib scripts
• clean:dist => run rimraf on the dist folder
• clean:es => run rimraf on the es folder
• clean:lib => run rimraf on the lib folder
• dev => start webpack playground App
• dist => run build and build:minified scripts
• lint => run ESLint on all files in src folder (also runs on dev script)
• lint:fix => run lint script, but with auto-fixer
• prepublish:compile => run lint, test:coverage, transpile:lib, transpile:es, and dist scripts
• start => run dev
• test => run AVA with NODE_ENV=test on all files in test folder
• test:coverage => run same script as test with code coverage calculation via nyc
• test:watch => run same script as test but keep persistent watcher
• transpile:es => run Babel on all files in src folder (transpiled to es folder without transpilation of ES2015 export syntax)
• transpile:lib => run Babel on all files in src folder (transpiled to lib folder)