🦕 serialize

Serializable

• Array
• Date
• Map
• Set
• URL
• Function
• Getters · accessor properties
• RegExp · literal or constructed
• BigInt · literal or constructed
• Symbol 🚧 · globals only · experimental
• Infinity
• undefined

The string returned from the serialize function is literal and valid JavaScript, which can be saved to a .js or .ts file, or even embedded inside of a <script> tag.

Usage

import { serialize } from "https://deno.land/x/serialize/mod.ts";

import { serialize } from "https://x.nest.land/serialize@1.0.0-rc.2/mod.ts";

serialize({
  strings: "string",
  booleans: true,
  numeric: 0,
  bigint1: 10n,
  bigint2: BigInt(10),
  regexp1: /([^\s]+)/g,
  regexp2: new RegExp("([^\\s]+)", "g"),
  objects: { foo: "foo" },
  arrayLikes: [1, 2, 3],
  actualNull: null,
  undefineds: undefined,
  nonFinites: Number.POSITIVE_INFINITY,
  dateObject: new Date(),
  mapObjects: new Map([["hello", "world"]]),
  setObjects: new Set([123, 456]),
  arrowFuncs: (arg) => `"${arg}"`,
  globalSyms: Symbol.for("Deno.customInspect"),
});

The above will produce the following string output:

'{"strg":"string","bool":true,"numb":0,"big1":BigInt("10"),"big2":BigInt("10"),"reg1":new RegExp("([^\\\\s]+)", "g"),"reg2":new RegExp("([^s]+)", "g"),"objs":{"foo":"foo"},"arrr":[1,2,3],"nill":null,"unde":undefined,"infi":Infinity,"date":new Date("2022-11-25T03:39:50.820Z"),"maps":new Map([["hello","world"]]),"sets":new Set([123,456]),"func":(arg)=>`"${arg}"`,"symb":Symbol.for("Deno.customInspect")}';

Note: to produced a beautified string, you can pass an optional second argument to serialize() to define the number of spaces to be used for the indentation.

Options

The serialize() function accepts an options object for a second argument, allowing fine-grained control of various aspects of the program's behavior.

interface SerializeOptions {
  /**
   * Serialize Arrays using the `Array.from` method, which may not be available
   * in all target environments (looking at you, Internet Explorer). Default
   * behavior is to use the `Array.prototype.splice` method, constructing an
   * Array from an Array-like object.
   * @default true
   */
  arrayFrom?: boolean;

  /**
   * Enable serializing of any functions encountered in the target object.
   * @default true
   */
  includeFunction?: boolean;

  /**
   * Serialize get property accessors ("getters") into their resolved values.
   * @default false
   */
  includeGetters?: boolean;

  /**
   * Serialize all properties, including any that are non-enumerable (hidden).
   * By default this is disabled, meaning that only enumerable properties are
   * serialized and included in the output.
   * @default false
   */
  includeHidden?: boolean;

  /**
   * Include `Symbol` primitives (typeof `symbol`) in the serialized output.
   * @default true
   */
  includeSymbols?: boolean;

  /**
   * Skips the replacement step, treating the input as pure JSON. This means
   * much faster processing times, at the cost of **no support** for objects
   * like RegExp/URL/Function/etc. `**You should probably leave this alone.**
   * @default false
   */
  isJSON?: boolean;

  /**
   * Serialize BigInt as literals.
   * @example BigInt("100") -> 100n
   * @default false
   */
  literalBigInt?: boolean;

  /**
   * Serialize RegExp as literals.
   * @example RegExp('(a|b|c)', 'g') -> /(a|b|c)/g
   * @default false
   */
  literalRegExp?: boolean;

  /**
   * Attempt to silently handle raised exceptions, rather than throwing hard
   * exceptions, by skipping over problem areas wherever possible. This is
   * ignored if a fatal error is thrown.
   * @default true
   */
  silent?: boolean;

  /**
   * Control the indentation width in the generated string.
   * Set to 0 to disable pretty-printing entirely.
   * @default 0
   */
  space?: string | number;

  /**
   * Sort entries of keyed collections (Array, Object, Set, Map).
   * @default false
   */
  sorted?: boolean;

  /**
   * Custom comparator to sort entries (implies {@linkcode sorted} is `true`).
   * **Note**: if {@linkcode sorted} is `false`, but this option is defined
   * with a valid comparator function, it will override the former and sort
   * all entries.
   * @default undefined
   */
  sortCompareFn?: ((a: unknown, b: unknown) => number) | null;

  /**
   * The maximum length of a string before it is truncated with an ellipsis.
   * @default undefined (no limit)
   */
  strAbbreviateSize?: number;

  /**
   * Skips sanitization of unsafe HTML characters.
   * @default false
   */
  unsafe?: boolean;
}

options.arrayFrom

Serialize Arrays using the Array.from method, which may not be available in all target environments.

Default behavior is to use the Array.prototype.splice method, constructing an Array from an Array-like object.

Default value is false

options.isJSON

This option indicates the target object does not contain any functions or RegExp expressions. This enables a hot-path that allows serialization to be over 3x faster. If you're serializing a lot of data, and know its pure JSON, then you can enable this option for a speed-up.

Default value is false

serialize(obj, { isJSON: true });

Note: when enabled the output is still be escaped to protect against XSS.

options.includeFunction

Disable this option to ignore JavaScript/TypeScript functions, treating them just like JSON.stringify (e.g. ignore them entirely). Other features will work as expected.

Default value is true

serialize(obj, { ignoreFunction: true });

options.includeGetters

Enable to include the source for getter accessor properties, which allow for computed values. If not enabled, their values will be calculated at the time of serialization and fixed to whatever the static output was at that point in time.

Default value is false

const obj = {
  name: "Nick",
  title: "dev",
  get greet() {
    return `Hello, I'm a ${this.title} named ${this.name}!`;
  },
};

serialize(obj);
// {"name":"Nick","title":"dev","greet":"Hello, I'm a dev named Nick!"}

serialize(obj, { includeGetters: true });
// {
//   "name": "Nick",
//   "title": "dev",
//   get greet () {
//     return `Hello, I'm a ${this.title} named ${this.name}!`;
//   }
// }

options.includeHidden

Serialize non-enumerable properties that are normally hidden.

Default value is false

options.includeSymbols

⚠️ experimental

Serialize values with the type of symbol. Only works with global symbols created with the Symbol.for() method. Any standard symbols will be coerced into globals, carrying over their description text (if any).

Default value is true

options.sorted

Sort entries of keyed collections (Array, Object, Set, Map).

Default value is false

options.sortCompareFn

Custom comparator to sort entries (implies options.sorted is true). Note: if sorted is false while this option is defined with a valid comparator function, it will override the former and sort all entries.

Default value is undefined

options.strAbbreviateSize

Note: not currently implemented

The maximum length of a string before it is truncated with an ellipsis.

Default value is undefined (no limit)

options.literalRegExp

Serialize Regular Expressions into literals, e.g. /.../i rather than the default RegExp("...", "i").

serialize({ pattern: /(foo|bar|baz)/i }, { literalRegExp: true });
// '{"pattern":/(foo|bar|baz)/i}'

Default value is false, with behavior as seen below.

serialize({ pattern: /(foo|bar|baz)/i });
// '{"pattern":new RegExp("(foo|bar|baz)","i")}'

Default value is false

options.literalBigInt

Serialize BigInt expressions into literals, e.g. 100n rather than the default BigInt("100").

serialize({ big: BigInt("100") }, { literalBigInt: true });
// '{"big":100n}'

Default value is false, with behavior as seen below.

serialize({ bigger: 200n });
// '{"bigger":BigInt("200")}'

options.silent

Attempt to silence most errors and diagnostic messages.

Default value is true

options.space

This option is the same as the space argument that can be passed to JSON.stringify. It can be used to add whitespace and indentation to the serialized output to make it more readable.

Default value is 0

serialize(obj, { space: 2 });

options.unsafe

This option is to signal serialize() that we want to do a straight conversion, without the XSS protection. This option needs to be explicitly set to true. HTML characters and JavaScript line terminators will not be escaped. You will have to roll your own.

Default value is false

serialize(obj, { unsafe: true });

Auto-Escaped Characters

One of the primary features of this module is to serialize code to a string of literal JavaScript, which can be safely embedded in an HTML document as the content of a <script> element.

In order to make this safe, HTML entities and JS line terminators are auto-escaped:

const dangerous = { haxorXSS: "</script>" };

The above will produce the following string, HTML-escaped output which is safe to put into an HTML document as it will not cause the inline script element to terminate:

serialize(dangerous);

// HTML entities have been safely escaped:
'{"haxorXSS":"\\u003C\\u002Fscript\\u003E"}';

You can pass unsafe argument to serialize() for straight serialization:

serialize(dangerous, { unsafe: true });

// HTML entities have NOT been escaped:
'{"haxorXSS":"</script>"}';

Deserializing

For some use cases you might also need to deserialize the string. This is explicitly not part of this module. However, you can easily write it yourself:

This is extremely unsafe, should probably be avoided, and is quite possibly unsupported by your environment. To understand why these risks exist, take a look at the code behind the deserialize function:

function deserialize<T>(serialized: string): T {
  return eval(`(${serialized})`) as T;
}

Warning: Don't forget to wrap the entire serialized string with parentheses, as seen as ( ) in the example above). Otherwise the opening bracket { will be considered to be the start of a body.

Type Safety

interface User {
  name: string;
  age: bigint;
}

// encoded to a plain old string
const encoded = serialize<User>({ name: "Nick", age: 29n });

// ensures the decoded data has a consistent type, and
// instructs our IDE which properties and types to anticipate.
const decoded = deserialize<User>(encoded);
// => { name: string; age: bigint; }

Contributing

This section assumes you have the GitHub CLI.

Fork the repository

gh repo fork deno911/serialize --clone

Create a feature branch

git checkout -b fix/typo-in-readme

Make some improvements

Don't forget to format, lint, and test your code before committing!

# hack hack hack...

deno fmt
deno lint --unstable
deno test --unstable -A --no-check

Commit your changes

Please try keep all changes concise and relevant to each other.

git add .

# all commits should be signed + verified with GPG/SSH
git commit -S -m "fix: typos in README.md"

git push

Open a Pull Request

gh pr create --title "fix: typos in README.md"

Or just open your repo on GitHub.com and follow the prompts.

Warning: make sure you select the upstream repo for your PR!