Compatibility

#Supported types

The modes are:

• Sync: serialize, toJSON, crossSerialize and toCrossJSON.
• Async: serializeAsync, toJSONAsync, crossSerializeAsync and toCrossJSONAsync.
• Streaming: crossSerializeStream, toCrossJSONStream and Serializer.

Web types such as URL, Request and FormData are supported through plugins.

#Feature flags

Every function takes a disabledFeatures option. It turns features off, so the output runs in older runtimes, or so a receiver rejects types it does not want.

disabledFeatures is a bit mask. Combine flags with |:

import { Feature, serialize } from 'seroval';

serialize(value, {
  disabledFeatures: Feature.AggregateError | Feature.BigIntTypedArray,
});

All features are on by default. For example, with ObjectAssign disabled:

const value = Object.assign(Object.create(null), { x: 1 });

serialize(value);
// Object.assign(Object.create(null),{x:1})

serialize(value, { disabledFeatures: Feature.ObjectAssign });
// (h=>h=(h=Object.create(null),h.x=1,h))()

#Runtimes

seroval runs anywhere modern JavaScript runs: Node.js 20 or later, Deno, Bun, browsers and edge runtimes. It has no dependencies.

#Package resolution

The seroval package has ESM and CommonJS builds, and a development build with full error messages. Bundlers pick the right one through the package's export conditions:

• The development condition selects the build with full error messages.
• The default selects the production build, which reports errors by code. See Errors.
• The browser condition selects the same build as the default, so there is never a second copy of seroval's classes or reference registry.

Resolvers that ignore export conditions, such as older bundlers and some React Native setups, can use the main and module fields. Binary encoding uses Buffer when it exists, and portable browser APIs otherwise. Both produce the same output.