npm

Need private packages and team management tools?Check out npm Orgs. »

tarant-local-storage

1.2.2 • Public • Published

logomakr_8pe69n

npm Build Status Coverage Status PRs Welcome issues Welcome npm GitHub issues GitHub pull requests Downloads

Motivation

Usually complex applications need to store offline part of the state, so it can be synced back or reused later. This module lets tarant store your actors serialized in the local storage and recovered implicitly.

Installation

Add it to your project using npm install tarant-local-storage --save or yarn add tarant-local-storage

Usage

You need to mark which classes need to be exported first. Usually this is done with the LocalStoragePersisted
class decorator.

import { Actor } from "tarant";
import { LocalStoragePersisted } from "tarant-local-storage";
 
export default class MyPersistedActor extends Actor {
    ...
}
LocalStoragePersisted("MyPersistedActor", MyPersistedActor) // NameOfThePersistedClass (unique), Class constructor

And then add the repository as a materializer and as a resolver:

import { ActorSystem, ActorSystemConfigurationBuilder } from 'tarant'
import MyPersistedActor from './actor';
import { LocalStoragePersisted, LocalStorageRepository } from 'tarant-local-storage';
 
window.onload = () => {
  const repository = new LocalStorageRepository()
 
  const system = ActorSystem.for(ActorSystemConfigurationBuilder.define()
  .withMaterializers([repository])
  .withResolvers([repository])
  .done())  
 
  system.actorOf(MyPersistedActor)
}
Created my free logo at LogoMakr.com

install

npm i tarant-local-storage

Downloadsweekly downloads

6

version

1.2.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability