seroval

seroval

Stringify JS values

Install

npm install --save seroval

yarn add seroval

pnpm add seroval

Usage

import { serialize } from 'seroval';

const object = {
  number: [Math.random(), -0, NaN, Infinity, -Infinity],
  string: ['hello world', '<script>Hello World</script>'],
  boolean: [true, false],
  null: null,
  undefined: undefined,
  bigint: 9007199254740991n,
  array: [,,,], // holes
  regexp: /[a-z0-9]+/i,
  date: new Date(),
  map: new Map([['hello', 'world']]),
  set: new Set(['hello', 'world']),
};

// self cyclic references
// recursive objects
object.self = object;
// recursive arrays
object.array.push(object.array);
// recursive maps
object.map.set('self', object.map);
// recursive sets
object.set.add(object.set);

// mutual cyclic references
object.array.push(object.map);
object.map.set('mutual', object.set);
object.set.add(object.array);

const result = serialize(object);
console.log(result);

Output (as a string):

((h,j,k,m,o)=>(o={number:[0.5337763749243287,-0,0/0,1/0,-1/0],string:["hello world","\x3Cscript>Hello World\x3C/script>"],boolean:[!0,!1],null:null,undefined:void 0,bigint:9007199254740991n,array:h=[,,,,k=(j=[],new Map([["hello","world"],["mutual",m=new Set(["hello","world"])]]))],regexp:/[a-z0-9]+/i,date:new Date("2023-12-07T17:28:57.909Z"),map:k,set:m},h[3]=h,k.set("self",k),m.add(m).add(h),o.self=o,o))()

// Formatted for readability
((h, j, k, m, o) => (
  (o = {
    number: [0.5337763749243287, -0, 0 / 0, 1 / 0, -1 / 0],
    string: ["hello world", "\x3Cscript>Hello World\x3C/script>"],
    boolean: [!0, !1],
    null: null,
    undefined: void 0,
    bigint: 9007199254740991n,
    array: (h = [
      ,
      ,
      ,
      ,
      (k =
        ((j = []),
        new Map([
          ["hello", "world"],
          ["mutual", (m = new Set(["hello", "world"]))],
        ]))),
    ]),
    regexp: /[a-z0-9]+/i,
    date: new Date("2023-12-07T17:28:57.909Z"),
    map: k,
    set: m,
  }),
  (h[3] = h),
  k.set("self", k),
  m.add(m).add(h),
  (o.self = o),
  o
))();

Docs

The documentation lives at seroval.vercel.app.

• Quick start
• Choosing a mode
• Streaming
• Plugins
• Security
• Compatibility
• API reference
• Playground

Sponsors

License

MIT © lxsmnsyc

Similar packages

Other packages similar to seroval

devalue

Serializes JavaScript values that JSON cannot represent directly, including circular references and types such as Date, Map, and Set. It is a close alternative for data serialization, but it focuses on producing a compact representation of data and does not aim to cover the same broader value-transport use cases.

superjson

Adds metadata to JSON so values such as Date, Map, Set, BigInt, and undefined can be restored. It is convenient when an application wants a JSON-compatible transport format, while seroval is geared toward serializing a broader range of JavaScript values and reference relationships.

flatted

Provides JSON-compatible stringify and parse functions for circular object graphs. It is a focused choice for cycles, but supports a narrower set of special JavaScript values than libraries designed to preserve richer types.

@ungap/structured-clone

Provides structured-clone-style support for copying or representing many built-in values and circular references. It is useful when the goal is to work with structured-clone semantics; its supported values and interface differ from seroval's serialization and parsing API.