dirp - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

coverage/coverage.json

@@ -1,1 +0,1 @@
-{"/Users/ytakeda/tmp/dirp/index.js":{"path":"/Users/ytakeda/tmp/dirp/index.js","s":{"1":1,"2":16,"3":13,"4":13,"5":16,"6":16,"7":1,"8":22,"9":22,"10":22,"11":34,"12":34,"13":12,"14":6,"15":12,"16":22,"17":1,"18":28,"19":28,"20":28,"21":41,"22":41,"23":11,"24":30,"25":17,"26":1,"27":5,"28":5,"29":5,"30":6,"31":6,"32":3,"33":3,"34":2,"35":2,"36":1,"37":1,"38":8,"39":1,"40":4,"41":1,"42":1,"43":1,"44":55,"45":1,"46":15},"b":{"1":[13,3],"2":[16,13],"3":[3,13],"4":[16,3],"5":[12,22],"6":[6,6],"7":[11,30],"8":[3,3],"9":[2,1]},"f":{"1":16,"2":22,"3":34,"4":28,"5":5,"6":8,"7":4,"8":1,"9":55,"10":15},"fnMap":{"1":{"name":"Dirp","line":3,"loc":{"start":{"line":3,"column":0},"end":{"line":3,"column":31}}},"2":{"name":"(anonymous_2)","line":12,"loc":{"start":{"line":12,"column":21},"end":{"line":12,"column":42}}},"3":{"name":"(anonymous_3)","line":15,"loc":{"start":{"line":15,"column":18},"end":{"line":15,"column":37}}},"4":{"name":"(anonymous_4)","line":28,"loc":{"start":{"line":28,"column":21},"end":{"line":28,"column":37}}},"5":{"name":"(anonymous_5)","line":41,"loc":{"start":{"line":41,"column":23},"end":{"line":41,"column":39}}},"6":{"name":"(anonymous_6)","line":57,"loc":{"start":{"line":57,"column":23},"end":{"line":57,"column":39}}},"7":{"name":"(anonymous_7)","line":61,"loc":{"start":{"line":61,"column":24},"end":{"line":61,"column":36}}},"8":{"name":"(anonymous_8)","line":65,"loc":{"start":{"line":65,"column":23},"end":{"line":65,"column":35}}},"9":{"name":"(anonymous_9)","line":69,"loc":{"start":{"line":69,"column":28},"end":{"line":69,"column":44}}},"10":{"name":"(anonymous_10)","line":74,"loc":{"start":{"line":74,"column":24},"end":{"line":74,"column":51}}}},"statementMap":{"1":{"start":{"line":3,"column":0},"end":{"line":10,"column":1}},"2":{"start":{"line":4,"column":4},"end":{"line":7,"column":5}},"3":{"start":{"line":5,"column":8},"end":{"line":5,"column":25}},"4":{"start":{"line":6,"column":8},"end":{"line":6,"column":28}},"5":{"start":{"line":8,"column":4},"end":{"line":8,"column":35}},"6":{"start":{"line":9,"column":4},"end":{"line":9,"column":77}},"7":{"start":{"line":12,"column":0},"end":{"line":26,"column":2}},"8":{"start":{"line":13,"column":4},"end":{"line":13,"column":38}},"9":{"start":{"line":14,"column":4},"end":{"line":14,"column":23}},"10":{"start":{"line":15,"column":4},"end":{"line":25,"column":7}},"11":{"start":{"line":16,"column":8},"end":{"line":16,"column":28}},"12":{"start":{"line":17,"column":8},"end":{"line":24,"column":9}},"13":{"start":{"line":18,"column":12},"end":{"line":20,"column":13}},"14":{"start":{"line":19,"column":16},"end":{"line":19,"column":29}},"15":{"start":{"line":21,"column":12},"end":{"line":21,"column":24}},"16":{"start":{"line":23,"column":12},"end":{"line":23,"column":26}},"17":{"start":{"line":28,"column":0},"end":{"line":39,"column":2}},"18":{"start":{"line":29,"column":4},"end":{"line":29,"column":38}},"19":{"start":{"line":30,"column":4},"end":{"line":30,"column":23}},"20":{"start":{"line":31,"column":4},"end":{"line":37,"column":5}},"21":{"start":{"line":32,"column":8},"end":{"line":32,"column":28}},"22":{"start":{"line":33,"column":8},"end":{"line":35,"column":9}},"23":{"start":{"line":34,"column":12},"end":{"line":34,"column":29}},"24":{"start":{"line":36,"column":8},"end":{"line":36,"column":20}},"25":{"start":{"line":38,"column":4},"end":{"line":38,"column":13}},"26":{"start":{"line":41,"column":0},"end":{"line":55,"column":2}},"27":{"start":{"line":42,"column":4},"end":{"line":42,"column":38}},"28":{"start":{"line":43,"column":4},"end":{"line":43,"column":23}},"29":{"start":{"line":44,"column":4},"end":{"line":54,"column":5}},"30":{"start":{"line":45,"column":8},"end":{"line":45,"column":28}},"31":{"start":{"line":46,"column":8},"end":{"line":48,"column":9}},"32":{"start":{"line":47,"column":12},"end":{"line":47,"column":19}},"33":{"start":{"line":49,"column":8},"end":{"line":52,"column":9}},"34":{"start":{"line":50,"column":12},"end":{"line":50,"column":27}},"35":{"start":{"line":51,"column":12},"end":{"line":51,"column":19}},"36":{"start":{"line":53,"column":8},"end":{"line":53,"column":20}},"37":{"start":{"line":57,"column":0},"end":{"line":59,"column":2}},"38":{"start":{"line":58,"column":4},"end":{"line":58,"column":42}},"39":{"start":{"line":61,"column":0},"end":{"line":63,"column":2}},"40":{"start":{"line":62,"column":4},"end":{"line":62,"column":50}},"41":{"start":{"line":65,"column":0},"end":{"line":67,"column":2}},"42":{"start":{"line":66,"column":4},"end":{"line":66,"column":48}},"43":{"start":{"line":69,"column":0},"end":{"line":71,"column":1}},"44":{"start":{"line":70,"column":4},"end":{"line":70,"column":35}},"45":{"start":{"line":74,"column":0},"end":{"line":76,"column":2}},"46":{"start":{"line":75,"column":4},"end":{"line":75,"column":37}}},"branchMap":{"1":{"line":4,"type":"if","locations":[{"start":{"line":4,"column":4},"end":{"line":4,"column":4}},{"start":{"line":4,"column":4},"end":{"line":4,"column":4}}]},"2":{"line":8,"type":"binary-expr","locations":[{"start":{"line":8,"column":18},"end":{"line":8,"column":27}},{"start":{"line":8,"column":31},"end":{"line":8,"column":34}}]},"3":{"line":9,"type":"cond-expr","locations":[{"start":{"line":9,"column":69},"end":{"line":9,"column":73}},{"start":{"line":9,"column":74},"end":{"line":9,"column":76}}]},"4":{"line":9,"type":"binary-expr","locations":[{"start":{"line":9,"column":18},"end":{"line":9,"column":42}},{"start":{"line":9,"column":46},"end":{"line":9,"column":66}}]},"5":{"line":17,"type":"if","locations":[{"start":{"line":17,"column":8},"end":{"line":17,"column":8}},{"start":{"line":17,"column":8},"end":{"line":17,"column":8}}]},"6":{"line":18,"type":"if","locations":[{"start":{"line":18,"column":12},"end":{"line":18,"column":12}},{"start":{"line":18,"column":12},"end":{"line":18,"column":12}}]},"7":{"line":33,"type":"if","locations":[{"start":{"line":33,"column":8},"end":{"line":33,"column":8}},{"start":{"line":33,"column":8},"end":{"line":33,"column":8}}]},"8":{"line":46,"type":"if","locations":[{"start":{"line":46,"column":8},"end":{"line":46,"column":8}},{"start":{"line":46,"column":8},"end":{"line":46,"column":8}}]},"9":{"line":49,"type":"if","locations":[{"start":{"line":49,"column":8},"end":{"line":49,"column":8}},{"start":{"line":49,"column":8},"end":{"line":49,"column":8}}]}}}}
+{"/Users/ytakeda/Projects/others/dirp/index.js":{"path":"/Users/ytakeda/Projects/others/dirp/index.js","s":{"1":1,"2":16,"3":13,"4":13,"5":16,"6":16,"7":1,"8":22,"9":22,"10":22,"11":34,"12":34,"13":12,"14":6,"15":12,"16":22,"17":1,"18":28,"19":28,"20":28,"21":41,"22":41,"23":11,"24":30,"25":17,"26":1,"27":5,"28":5,"29":5,"30":6,"31":6,"32":3,"33":3,"34":2,"35":2,"36":1,"37":1,"38":8,"39":1,"40":4,"41":1,"42":1,"43":1,"44":55,"45":1,"46":15},"b":{"1":[13,3],"2":[16,13],"3":[3,13],"4":[16,3],"5":[12,22],"6":[6,6],"7":[11,30],"8":[3,3],"9":[2,1]},"f":{"1":16,"2":22,"3":34,"4":28,"5":5,"6":8,"7":4,"8":1,"9":55,"10":15},"fnMap":{"1":{"name":"Dirp","line":3,"loc":{"start":{"line":3,"column":0},"end":{"line":3,"column":31}}},"2":{"name":"(anonymous_2)","line":12,"loc":{"start":{"line":12,"column":21},"end":{"line":12,"column":42}}},"3":{"name":"(anonymous_3)","line":15,"loc":{"start":{"line":15,"column":18},"end":{"line":15,"column":37}}},"4":{"name":"(anonymous_4)","line":28,"loc":{"start":{"line":28,"column":21},"end":{"line":28,"column":37}}},"5":{"name":"(anonymous_5)","line":41,"loc":{"start":{"line":41,"column":23},"end":{"line":41,"column":39}}},"6":{"name":"(anonymous_6)","line":57,"loc":{"start":{"line":57,"column":23},"end":{"line":57,"column":39}}},"7":{"name":"(anonymous_7)","line":61,"loc":{"start":{"line":61,"column":21},"end":{"line":61,"column":33}}},"8":{"name":"(anonymous_8)","line":65,"loc":{"start":{"line":65,"column":23},"end":{"line":65,"column":35}}},"9":{"name":"(anonymous_9)","line":69,"loc":{"start":{"line":69,"column":28},"end":{"line":69,"column":44}}},"10":{"name":"(anonymous_10)","line":74,"loc":{"start":{"line":74,"column":24},"end":{"line":74,"column":51}}}},"statementMap":{"1":{"start":{"line":3,"column":0},"end":{"line":10,"column":1}},"2":{"start":{"line":4,"column":4},"end":{"line":7,"column":5}},"3":{"start":{"line":5,"column":8},"end":{"line":5,"column":25}},"4":{"start":{"line":6,"column":8},"end":{"line":6,"column":28}},"5":{"start":{"line":8,"column":4},"end":{"line":8,"column":35}},"6":{"start":{"line":9,"column":4},"end":{"line":9,"column":77}},"7":{"start":{"line":12,"column":0},"end":{"line":26,"column":2}},"8":{"start":{"line":13,"column":4},"end":{"line":13,"column":38}},"9":{"start":{"line":14,"column":4},"end":{"line":14,"column":23}},"10":{"start":{"line":15,"column":4},"end":{"line":25,"column":7}},"11":{"start":{"line":16,"column":8},"end":{"line":16,"column":28}},"12":{"start":{"line":17,"column":8},"end":{"line":24,"column":9}},"13":{"start":{"line":18,"column":12},"end":{"line":20,"column":13}},"14":{"start":{"line":19,"column":16},"end":{"line":19,"column":29}},"15":{"start":{"line":21,"column":12},"end":{"line":21,"column":24}},"16":{"start":{"line":23,"column":12},"end":{"line":23,"column":26}},"17":{"start":{"line":28,"column":0},"end":{"line":39,"column":2}},"18":{"start":{"line":29,"column":4},"end":{"line":29,"column":38}},"19":{"start":{"line":30,"column":4},"end":{"line":30,"column":23}},"20":{"start":{"line":31,"column":4},"end":{"line":37,"column":5}},"21":{"start":{"line":32,"column":8},"end":{"line":32,"column":28}},"22":{"start":{"line":33,"column":8},"end":{"line":35,"column":9}},"23":{"start":{"line":34,"column":12},"end":{"line":34,"column":29}},"24":{"start":{"line":36,"column":8},"end":{"line":36,"column":20}},"25":{"start":{"line":38,"column":4},"end":{"line":38,"column":13}},"26":{"start":{"line":41,"column":0},"end":{"line":55,"column":2}},"27":{"start":{"line":42,"column":4},"end":{"line":42,"column":38}},"28":{"start":{"line":43,"column":4},"end":{"line":43,"column":23}},"29":{"start":{"line":44,"column":4},"end":{"line":54,"column":5}},"30":{"start":{"line":45,"column":8},"end":{"line":45,"column":28}},"31":{"start":{"line":46,"column":8},"end":{"line":48,"column":9}},"32":{"start":{"line":47,"column":12},"end":{"line":47,"column":19}},"33":{"start":{"line":49,"column":8},"end":{"line":52,"column":9}},"34":{"start":{"line":50,"column":12},"end":{"line":50,"column":27}},"35":{"start":{"line":51,"column":12},"end":{"line":51,"column":19}},"36":{"start":{"line":53,"column":8},"end":{"line":53,"column":20}},"37":{"start":{"line":57,"column":0},"end":{"line":59,"column":2}},"38":{"start":{"line":58,"column":4},"end":{"line":58,"column":42}},"39":{"start":{"line":61,"column":0},"end":{"line":63,"column":2}},"40":{"start":{"line":62,"column":4},"end":{"line":62,"column":50}},"41":{"start":{"line":65,"column":0},"end":{"line":67,"column":2}},"42":{"start":{"line":66,"column":4},"end":{"line":66,"column":45}},"43":{"start":{"line":69,"column":0},"end":{"line":71,"column":1}},"44":{"start":{"line":70,"column":4},"end":{"line":70,"column":35}},"45":{"start":{"line":74,"column":0},"end":{"line":76,"column":2}},"46":{"start":{"line":75,"column":4},"end":{"line":75,"column":37}}},"branchMap":{"1":{"line":4,"type":"if","locations":[{"start":{"line":4,"column":4},"end":{"line":4,"column":4}},{"start":{"line":4,"column":4},"end":{"line":4,"column":4}}]},"2":{"line":8,"type":"binary-expr","locations":[{"start":{"line":8,"column":18},"end":{"line":8,"column":27}},{"start":{"line":8,"column":31},"end":{"line":8,"column":34}}]},"3":{"line":9,"type":"cond-expr","locations":[{"start":{"line":9,"column":69},"end":{"line":9,"column":73}},{"start":{"line":9,"column":74},"end":{"line":9,"column":76}}]},"4":{"line":9,"type":"binary-expr","locations":[{"start":{"line":9,"column":18},"end":{"line":9,"column":42}},{"start":{"line":9,"column":46},"end":{"line":9,"column":66}}]},"5":{"line":17,"type":"if","locations":[{"start":{"line":17,"column":8},"end":{"line":17,"column":8}},{"start":{"line":17,"column":8},"end":{"line":17,"column":8}}]},"6":{"line":18,"type":"if","locations":[{"start":{"line":18,"column":12},"end":{"line":18,"column":12}},{"start":{"line":18,"column":12},"end":{"line":18,"column":12}}]},"7":{"line":33,"type":"if","locations":[{"start":{"line":33,"column":8},"end":{"line":33,"column":8}},{"start":{"line":33,"column":8},"end":{"line":33,"column":8}}]},"8":{"line":46,"type":"if","locations":[{"start":{"line":46,"column":8},"end":{"line":46,"column":8}},{"start":{"line":46,"column":8},"end":{"line":46,"column":8}}]},"9":{"line":49,"type":"if","locations":[{"start":{"line":49,"column":8},"end":{"line":49,"column":8}},{"start":{"line":49,"column":8},"end":{"line":49,"column":8}}]}}}}

index.js

@@ -61,3 +61,3 @@ 'use strict';
 
-Dirp.prototype.toJSON = function () {
+Dirp.prototype.raw = function () {
     return JSON.parse(JSON.stringify(this._data));
@@ -67,3 +67,3 @@ };
 Dirp.prototype.clone = function () {
-    return new Dirp(this._delim, this.toJSON());
+    return new Dirp(this._delim, this.raw());
 };
@@ -70,0 +70,0 @@

package.json

 {
   "name": "dirp",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Object directory accessor using tokenized path string.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -15,14 +15,21 @@ # dirp
 capitals.set('us.california', 'sacramento');
-
+capitals.set('jp.tokyo', 'shinjuku');
+capitals.set('jp.osaka', 'osaka');
+ 
 console.log(capitals.get('us.alabama'));
--> mongomery
-
+// mongomery
+ 
 console.log(capitals.get('us.california'));
--> sacramento
+// sacramento
+ 
+console.log(capitals.raw());
+// { us: { alabama: 'montgomery', california: 'sacramento' },
+//   jp: { tokyo: 'shinjuku', osaka: 'osaka' } }
 
-console.log(capitals.get('us.tokyo'));
--> undefined
-
-capitals.uset('us'); // clear all data at paths that start with 'us'
-
+console.log(capitals.get('us.tokyo')); // incorrect
+// undefined
+ 
+capitals.unset('us'); // clear all data at paths that start with 'us' 
+console.log(capitals.raw());
+// { jp: { tokyo: 'shinjuku', osaka: 'osaka' } }
 ```
@@ -33,24 +40,43 @@
 ### Constructor
+#### create
 ```
 create(delimiter, data) => instance {Dirp}
 create(delimiter) => instance {Dirp}
-create(delimiter) => instance {Dirp}
+create(data) => instance {Dirp}
 ```
-* delimiter {string} Path delimiter. Defaults to '.'
-* data {object} Initial object. Defaults to {}
+* delimiter {string} *optional* Path delimiter. Defaults to '.'
+* data {object} *optional* Initial object. Defaults to {}
 
 ### Instance Methods
-#### set(path, value) => {void}
+#### set
+```
+set(path, value) => {void}
+```
 * path {string} Path to a value
 * value {any} Aribtrary value
 
-#### get(path) => value {any}
+#### get
+```
+get(path) => value {any}
+```
 * path {string} Path to a value
 
-#### unset(path) => {void}
+#### unset
+```
+unset(path) => {void}
+```
 * path {string} Path to be unset
 
 #### exist(path) => {boolean}
+```
+exist(path) => {boolean}
+```
 * path {string} Path to be tested
-
#### toJSON() => {object}
-
#### clone() => {Dirp}
+
#### raw
+```
+raw() => {object}
+```
+
#### clone
+```
+clone() => {Dirp}
+```

No alert changes

Improved metrics

Total package byte prevSize

54571

0.85%

Number of lines in readme file

81

47.27%

No dependency changes