Skip to content

CHANGELOG.md

Latest commit

 

History

History
159 lines (111 loc) · 5.02 KB

CHANGELOG.md

File metadata and controls

159 lines (111 loc) · 5.02 KB

Changelog

Next

  • Added 'string' as possible bigint option value. Bigint values are serialized as JSON strings using it.
import { configure } from 'safe-stable-stringify'

const stringify = configure({
  bigint: 'string'
})

stringify([1n, 2, 3n, 4, 5n])
// '["1",2,"3",4,"5"]'
  • Fixed off by one error using the maximumBreadth option. It showed one entry to few being skipped.
  • Added safe option to not fail in case a getter, .toJSON(), or a replacer throws an error. Instead, a string as error message is replacing the object inspection. This allows to partially inspect such objects. The default is false to prevent any breaking change.
import { configure } from 'safe-stable-stringify'

const stringify = configure({
  safe: true
})

stringify([{
  foo: { a: 5, get foo() { throw new Error('Oops') }, c: true }
}])
// '[{"foo":"Error: Stringification failed. Message: Oops"}]'

stringify([{
  foo: { a: 5, toJSON() { throw new Error('Oops') }, c: true }
}])
// '[{"foo":"Error: Stringification failed. Message: Oops"}]'

v2.5.0

  • Accept Array#sort(comparator) comparator method as deterministic option value to use that comparator for sorting object keys.
import { configure } from 'safe-stable-stringify'

const object = {
  a: 1,
  b: 2,
  c: 3,
}

const stringify = configure({
  deterministic: (a, b) => b.localeCompare(a)
})

stringify(object)
// '{"c":3,"b":2,"a":1}'
  • Very minor performance optimization.

Thanks to @flobernd, @cesco69 and @prisis to contribute to this release!

v2.4.3

  • Fixed toJSON function receiving array keys as number instead of string
  • Fixed replacer function receiving array keys as number instead of string
  • Fixed replacer function not being called for TypedArray entries
  • Improved performance to escape long strings that contain characters that need escaping

v2.4.2

  • Improved ESM TypeScript types.
  • More precise TypeScript replacer type.

v2.4.1

  • More precise TypeScript types. The return type is now either string, undefined or string | undefined depending on the input.

v2.4.0

  • Added strict option to verify that the passed in objects are fully compatible with JSON without removing information. If not, an error is thrown.
  • Fixed TypeScript definition for ESM code bases

v2.3.1

  • Fix invalid regexp group error in browsers or environments that do not support the negative lookbehind regular expression assertion.

v2.3.0

  • Accept the Error constructor as circularValue option to throw on circular references as the regular JSON.stringify would:
import { configure } from 'safe-stable-stringify'

const object = {}
object.circular = object;

const stringify = configure({ circularValue: TypeError })

stringify(object)
// TypeError: Converting circular structure to JSON
  • Fixed escaping wrong surrogates. Only lone surrogates are now escaped.

v2.2.0

  • Reduce module size by removing the test and benchmark files from the published package
  • Accept undefined as circularValue option to remove circular properties from the serialized output:
import { configure } from 'safe-stable-stringify'

const object = { array: [] }
object.circular = object;
object.array.push(object)

configure({ circularValue: undefined })(object)
// '{"array":[null]}'

v2.1.0

  • Added maximumBreadth option to limit stringification at a specific object or array "width" (number of properties / values)
  • Added maximumDepth option to limit stringification at a specific nesting depth
  • Implemented the well formed stringify proposal that is now part of the spec
  • Fixed maximum spacer length (10)
  • Fixed TypeScript definition
  • Fixed duplicated array replacer values serialized more than once

v2.0.0

  • [BREAKING] Convert BigInt to number by default instead of ignoring these values If you wish to ignore these values similar to earlier versions, just use the new bigint option and set it to false.
  • [BREAKING] Support ESM
  • [BREAKING] Requires ES6
  • Optional BigInt support
  • Deterministic behavior is now optional
  • The value to indicate a circular structure is now adjustable
  • Significantly faster TypedArray stringification
  • Smaller Codebase
  • Removed stateful indentation to guarantee side-effect freeness

v1.1.1

  • Fixed an indentation issue in combination with empty arrays and objects
  • Updated dev dependencies

v1.1.0