redux-devtools/packages/redux-devtools-serialize
Nathan Bierema a418284a4a
chore(extension): convert to TypeScript (#756)
* Start work

* More work

* stash

* stash

* stash

* Eliminate relay

* Fix

* Define page script to content script messages

* Define ContentScriptToPageScriptMessage

* Not required

* Fill out more types

* More work on types

* More type fixes

* Add type

* More improvements to types

* More work on types

* Fix more type errors

* More changes

* More work

* Work

* Fix build

* Fix lint

* Fix more lint

* Fix bug

* Fix tests
2021-08-25 00:22:54 -04:00
..
src chore(core): convert to TypeScript (#655) 2020-10-25 19:32:04 -04:00
test chore(*): upgrade prettier (#743) 2021-06-17 23:56:36 -04:00
.babelrc feat(redux-devtools-serialize): convert to TypeScript (#621) 2020-08-29 00:14:49 -04:00
.eslintignore feat(redux-devtools-serialize): convert to TypeScript (#621) 2020-08-29 00:14:49 -04:00
.eslintrc.js feat(redux-devtools-serialize): convert to TypeScript (#621) 2020-08-29 00:14:49 -04:00
CHANGELOG.md chore(*): run prettier 2021-03-06 10:17:55 -05:00
jest.config.js feat(redux-devtools-serialize): convert to TypeScript (#621) 2020-08-29 00:14:49 -04:00
package.json chore(extension): convert to TypeScript (#756) 2021-08-25 00:22:54 -04:00
README.md chore(*): make more packages scoped (#692) 2020-12-21 15:46:28 -05:00
tsconfig.json feat(redux-devtools-serialize): convert to TypeScript (#621) 2020-08-29 00:14:49 -04:00

Serialize ImmutableJS data

Installation

yarn add @redux-devtools/serialize

Usage with ImmutableJS data structures

Just pass the Immutable library to our class:

import Immutable from 'immutable';
import Serialize from '@redux-devtools/serialize';
const { stringify, parse } = Serialize.immutable(Immutable);

const data = Immutable.fromJS({ foo: 'bar', baz: { qux: 42 } });
const serialized = stringify(data);
console.log(serialized);
// {"data":{"foo":"bar","baz":{"data":{"qux":42},"__serializedType__":"ImmutableMap"}},"__serializedType__":"ImmutableMap"}
const parsed = parse(serialized);
console.log(Immutable.is(parsed, data));
// true

See the tests for more examples of usage.

Usage with ImmutableJS Record classes

To parse a Record class back, you need to specify a reference to it:

import Immutable from 'immutable';
import Serialize from '@redux-devtools/serialize';

const ABRecord = Immutable.Record({ a: 1, b: 2 });
const { stringify, parse } = Serialize.immutable(Immutable, [ABRecord]);

const myRecord = new ABRecord({ b: 3 });
const serialized = stringify(myRecord);
console.log(serialized);
// {"data":{"a":1,"b":3},"__serializedType__":"ImmutableRecord","__serializedRef__":0}
const parsed = parse(serialized);
console.log(Immutable.is(parsed, myRecord));
// true

Passing custom serialization functions

You can pass custom replacer and reviver functions to Serialize:

import Immutable from 'immutable';
import Serialize from '@redux-devtools/serialize';

function customReplacer(key, value, defaultReplacer) {
  if (value === 1) {
    return { data: 'one', __serializedType__: 'number' };
  }
  return defaultReplacer(key, value);
}

function customReviver(key, value, defaultReviver) {
  if (
    typeof value === 'object' &&
    value.__serializedType__ === 'number' &&
    value.data === 'one'
  ) {
    return 1;
  }
  return defaultReviver(key, value);
}

const { stringify, parse } = Serialize.immutable(
  Immutable,
  null,
  customReplacer,
  customReviver
);

const map = Immutable.Map({ a: 1, b: 2 });
const serialized = stringify(map);
console.log(serialized);
// {"data":{"a":{"data":"one","__serializedType__":"number"},"b":2},"__serializedType__":"ImmutableMap"}
const parsed = parse(serialized);
console.log(Immutable.is(parsed, map));
// true

Supported

ImutableJS

  • Record
  • Range
  • Repeat
  • Map
  • OrderedMap
  • List
  • Set
  • OrderedSet
  • Seq
  • Stack

ES6

  • Symbol
  • Map
  • Set
  • Typed Array

License

MIT