lng-storage

Lightning Storage

Plugin that created to simplify data storage and dynamically update the Lightning components✨

GitHub repository with an example of usage storage + router public repository.

Init

LS.init([
    {
        name: 'main', // Storage name
        defaultValues: [{key: 'color', value: 0xff225cb3, external: true }] // default values object
    }
], true); // by default log parameter is false

Basic Usage

import { Lightning, Utils } from "@lightningjs/sdk";
import LS from "lng-storage";

export default class Home extends Lightning.Component {
    _setup() {
      LS.addAction('main', 'color', this.id, this._setBackgroundColor);
    }

    _init() {
      this.patch({
        Background: {
          rect: true,
          w: 1920,
          h: 1080,
          color: LS.get('main', 'color'),
        },
        Logo: {
          mountX: 0.5,
          mountY: 1,
          x: 960,
          y: 600,
          src: Utils.asset('images/logo.png'),
        },
        Text: {
          mount: 0.5,
          x: 960,
          y: 720,
          text: {
            text: "Home",
            fontFace: 'Regular',
            fontSize: 64,
            textColor: 0xbbffffff,
          },
        },
      })
    }

    _setBackgroundColor = (_key, _old, current) => {
      this.tag('Background').patch({ color: current });
    }
}

Methods

LS.init(config, log) - Initialization of the Storages;

LS.get(storageName, key) - Get data by storage name and property key;

LS.set(storageName, key, value) - Set data by storage name and propery key;

LS.setToDefault(storageName) - Set storage data to default values by storage name;

LS.getAll(storageName) - Get whole storage object by storage name;

NOTE: To prevent memoty leak we should delete all callbacks when component have been detached and should pass Lightning component is as contextId!
LS.addAction(storageName, key, contextId, callback) - Add an event for the key that will be triggered when the value is changed (callback(key, oldValue, newValue));

LS.addActions(storageName, keys, contextId, callback) - Add an event for the keys (Array of keys) that will be triggered when the value of some key is changed (callback(key, oldValue, newValue));

LS.removeActions(storageName, contextId) - Removes all actions of storage for separate contextId;

GitHub public repository.