electrum-store - npm Package Compare versions

Comparing version 1.3.0 to 1.4.0

lib/store/state.js

@@ -97,2 +97,14 @@ 'use strict';
   }, {
+    key: 'getInherited',
+    value: function getInherited(id) {
+      var value = this.get(id);
+      if (value !== undefined) {
+        return value;
+      }
+      var parent = this.parentId;
+      if (parent !== undefined) {
+        return this.store.find(parent).getInherited(id);
+      }
+    }
+  }, {
     key: 'set',
@@ -167,2 +179,7 @@ value: function set() {
   }, {
+    key: 'parentId',
+    get: function get() {
+      return State.getParentId(this._id);
+    }
+  }, {
     key: 'store',
@@ -169,0 +186,0 @@ get: function get() {

package.json

 {
   "name": "electrum-store",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Electrum store provides a store implementation tailored for Electrum.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -106,2 +106,4 @@ # Electrum Store
   exists, otherwise `undefined`.
+* `getInherited (id)` → the value for `id` if it can be found on the state
+  or any of its parent nodes, otherwise `undefined`.
 * `any (id)` or `any ()` → `true` if the state specified by `id` exists
@@ -111,2 +113,7 @@ and if it is non-empty.
 
+The state can also be used as a staring point for `find()` and `select()`.
+Without any argument, they return the state itself.
+`select()` creates missing nodes whereas `find()` returns `undefined` if
+it does not find the specified nodes.
+
 ## Create state
@@ -113,0 +120,0 @@

src/store/state.js

@@ -58,2 +58,6 @@ 'use strict';
 
+  get parentId () {
+    return State.getParentId (this._id);
+  }
+
   get store () {
@@ -90,2 +94,13 @@ return this._store;
 
+  getInherited (id) {
+    const value = this.get (id);
+    if (value !== undefined) {
+      return value;
+    }
+    const parent = this.parentId;
+    if (parent !== undefined) {
+      return this.store.find (parent).getInherited (id);
+    }
+  }
+
   set (...args) {
@@ -92,0 +107,0 @@ if (args.length === 1) {

src/test/state.js

@@ -205,2 +205,36 @@ 'use strict';
   });
+
+  describe ('parentId', () => {
+    it ('returns the parent id', () => {
+      const store = Store.create ();
+      const state = store.select ('a.b.c');
+      expect (state.parentId).to.equal ('a.b');
+      expect (store.find ('a').parentId).to.equal ('');
+    });
+
+    it ('returns undefined for the root', () => {
+      const store = Store.create ();
+      store.select ('a.b.c');
+      expect (store.root.parentId).to.not.exist ();
+    });
+  });
+
+  describe ('getInherited', () => {
+    const store = Store.create ();
+    store.select ('a.b.c');
+    store.select ('a').set ('x', 1);
+    store.select ('a.b').set ('x', 2);
+    store.root.set ('y', 3);
+    store.select ('a').set ('z', 4);
+
+    it ('returns the first value found in the tree', () => {
+      expect (store.find ('a.b.c').getInherited ('x')).to.equal (2);
+      expect (store.find ('a.b').getInherited ('x')).to.equal (2);
+      expect (store.find ('a').getInherited ('x')).to.equal (1);
+      expect (store.root.getInherited ('x')).to.not.exist ();
+      expect (store.root.getInherited ('y')).to.equal (3);
+      expect (store.find ('a.b.c').getInherited ('z')).to.equal (4);
+      expect (store.find ('a.b.c').getInherited ('y')).to.equal (3);
+    });
+  });
 });

No alert changes

Improved metrics

Total package byte prevSize

72860

increased by3.37%

Lines of code

1746

increased by3.56%

Number of lines in readme file

182

increased by4%

No dependency changes