Skip to main content

Serializer

The serializer enables you to serialize some Boxed values (e.g. to store in LocalStorage, or to hydrate data from SSR).

import { Serializer } from "@swan-io/boxed";

Serializer.encode(value)​

Stringifies the input to JSON, managing the AsyncData, Option and Result types properly.

Serializer.encode({
  data: AsyncData.Done({
    name: Option.None(),
  }),
});
// {"data":{"__boxed_type__":"AsyncData","tag":"Done","value":{"name":{"__boxed_type__":"Option","tag":"None"}}}}

Serializer.decode(value)​

Parse the JSON input, reviving the AsyncData, Option and Result types properly.

Serializer.decode(`{"__boxed_type__":"Option","tag":"None"}`); // Option.None();