Allow passing engine options in `load()` #141

Closed

elliottsj wants to merge 1 commit from engine-config-load into master

elliottsj commented

2016-05-31 20:10:39 +00:00

(Migrated from github.com)

For #140.

This backwards-compatible change allows you to pass options to the engine as part of the load() call, e.g.

const load = storage.createLoader(engine);
// ...
load(store, 'my-save-key', { foo: 'bar' });

For example, a localForage engine can be implemented like this:

// localForageEngine.js

import localforage from 'localforage';

export default function createEngine() {
  let key;
  let engineConfig;
  return {
    load(...engineOpts) {
      if (!engineConfig) {
        [key, engineConfig] = engineOpts;
        localforage.config(engineConfig);
      }
      return localforage.getItem(key);
    },

    save(state) {
      if (!engineConfig) {
        throw new Error('LocalForage is not configured; you must call `load(config)`');
      }
      return localforage.setItem(key, state);
    },
  };
}

For #140. This backwards-compatible change allows you to pass options to the engine as part of the `load()` call, e.g. ``` js const load = storage.createLoader(engine); // ... load(store, 'my-save-key', { foo: 'bar' }); ``` For example, a localForage engine can be implemented like this: ``` js // localForageEngine.js import localforage from 'localforage'; export default function createEngine() { let key; let engineConfig; return { load(...engineOpts) { if (!engineConfig) { [key, engineConfig] = engineOpts; localforage.config(engineConfig); } return localforage.getItem(key); }, save(state) { if (!engineConfig) { throw new Error('LocalForage is not configured; you must call `load(config)`'); } return localforage.setItem(key, state); }, }; } ```

👍 1

michaelcontento commented

2016-06-08 13:41:14 +00:00

(Migrated from github.com)

For a full discussion about this feature please see #140