akiroz / re-frame-storage

re-frame interceptors for browser local storage

re-frame-storage

A very simple re-frame wrapper around storage-atom for persisting app state.

Depends on re-frame >= 0.8.0.

Usage

There are 2 ways to use this:

1. As individual re-frame fx & cofx

(ns my-app
  (:require [akiroz.re-frame.storage :refer [reg-co-fx!]]))

;; both :fx and :cofx keys are optional, they will not be registered if unspecified.
(reg-co-fx! :my-app         ;; local storage key
            {:fx :store     ;; re-frame fx ID
             :cofx :store}) ;; re-frame cofx ID

;; ...

(reg-event-fx
  :read-foo-store-bar
  [(inject-cofx :store)]
  (fn [{:keys [store]} _]
    (print (:foo store))
    {:store (assoc store :bar "qux")}))

2. As a re-frame interceptor that automatically persists part of your app-db

(ns my-app
  (:require [akiroz.re-frame.storage :refer [persist-db]]))

;; define a custom reg-event-db
;; local storage key is :my-app
;; everything inside the db's :persistent key is automatically stored and retreived.
(defn my-reg-event-db
  [event-id handler]
  (reg-event-fx
    event-id
    [(persist-db :my-app :persistent)]
    (fn [{:keys [db]} event-vec]
      {:db (handler db event-vec)})))

;; ...

(my-reg-event-db
  :read-foo-store-bar
  (fn [db _]
    (print (get-in db [:persistent :foo]))
    (assoc-in db [:persistent :bar] "qux")))

;; Or, if you want to persist multiple DB keys:

(defn my-reg-event-db
  [event-id handler]
  (reg-event-fx
    event-id
    [(persist-db-keys :my-app [:persistent-1 :persistent-2])]
    (fn [{:keys [db]} event-vec]
      {:db (handler db event-vec)})))

;; May want an init helper to dispatch on app init

(my-reg-event-db :init (fn [db] db))

re-frame-storage's Issues

Spec namespace renamed

storage.cljs references the outdated namespace cljs.spec.alpha, which has been replaced by cljs.spec.

https://github.com/akiroz/re-frame-storage/blob/master/src/akiroz/re_frame/storage.cljs#L4

Unsetting value

Is there a way to unset a previously registered value? My use case is saving credentials until a user logs out. Just dissocing it doesn't work because the library seems to check for non-nil values. Why is that?

Persist entire db with interceptor

In some cases, one would like to persist the entire database in local storage with the interceptor.
For the moment my solution is to create an interceptor for every key of my db.

App not registered when using reg-co-fx!

I'm using the library like so, copying directly from the README.

;; both :fx and :cofx keys are optional, they will not be registered if unspecified.
(reg-co-fx! :my-app         ;; local storage key
            {:fx :store     ;; re-frame fx ID
             :cofx :store}) ;; re-frame cofx ID

But I'm getting the following error when I put this snippet:

How to fix this error?

add missing dep "org.clojure/spec.alpha"

Please add missing dependence "org.clojure/spec.alpha". Thx