maiermic / cycle-storageify

Augments your Cycle.js component (main function) by storing its onion-shaped state in local storage

Cycle.js storageify

Augments your Cycle.js component (main function) by storing its onion-shaped state in local storage.

Quick example

import onionify from 'cycle-onionify';
import storageify from 'cycle-storageify';
import storageDriver from '@cycle/storage';
// ...

const wrappedMain = onionify(storageify(main, {key: 'my-local-storage-key'}));

Cycle.run(wrappedMain, {
  DOM: makeDOMDriver('#app'),
  storage: storageDriver,
});

Advanced example

See onionify branch of TodoMVC in Cycle.js.

cycle-storageify's Issues

XStream should be a peerDependency

Related to cyclejs-community/create-cycle-app#117

Projects created using CCA and cycle-scripts-one-fits-all include xstream twice: as a high-level dependency and for cycle-storageify. So, could you consider to move it to a peerDependency, helping on reducing the bundle size?

Thanks.

The second and third options should be declared as optional

https://github.com/maiermic/cycle-storageify/blob/master/src/index.ts#L34-L35

as hard to use from TypeScript

I had to declare a type for the structure and cast it.

final storage$ overwrites the one from componentSinks

Hi there,

maybe I'm wrong but shouldn't it be something like

...
const stateStorage$ = state$.map(_options.serialize)
  .map(value => ({key: _options.key, value}));

const storage$ = componentSinks.storage
  ? xs.merge(stateStorage$, componentSinks.storage)
  : stateStorage$

Otherwise if there is already a componentSinks.storage it would just be replaced not augmented?