serializable-bptree 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 izure
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # serializable-bptree
 
-[![](https://data.jsdelivr.com/v1/package/npm/serializable-bptree/badge)](https://www.jsdelivr.com/package/npm/serialiable-bptree)
+[![](https://data.jsdelivr.com/v1/package/npm/serializable-bptree/badge)](https://www.jsdelivr.com/package/npm/serializable-bptree)
 ![Node.js workflow](https://github.com/izure1/serializable-bptree/actions/workflows/node.js.yml/badge.svg)
 
 This is a B+tree that's totally okay with duplicate values. If you need to keep track of the B+ tree's state, don't just leave it in memory - make sure you write it down.
@@ -81,7 +81,7 @@ import { BPTree } from 'serializable-bptree'
 </script>
 ```
 
-## conceptualization
+## Conceptualization
 
 ### Value comparator
 
@@ -190,7 +190,7 @@ This kind of delay writing should ideally occur within a few milliseconds. If th
 
 #### readHead(): `SerializeStrategyHead`|`null`
 
-This method is called only once when the tree is created. It's a method to restore the saved tree information. If it's the first tree creation and there are no saved tree information, return `null`.
+This method is called only once when the tree is created. It's a method to restore the saved tree information. If it is the initial creation and there is no stored root node, it should return `null`.
 
 This method should return the value stored in the `writeHead` method.
 
@@ -200,7 +200,6 @@ This method is called whenever the head information of the tree changes, typical
 
 As a parameter, it receives the header information of the tree. This value should be serialized and stored. Later, the `readHead` method should convert this serialized value into a json format and return it.
 
-
 ### The Default `ValueComparator` and `SerializeStrategy`
 
 To utilize `serializable-bptree`, you need to implement certain functions. However, a few basic helper classes are provided by default.

package/dist/cjs/index.js

@@ -724,7 +724,7 @@ var InMemoryStoreStrategy = class extends SerializeStrategy {
     return Math.ceil(Math.random() * Number.MAX_SAFE_INTEGER - 1);
   }
   read(id) {
-    if (Object.prototype.hasOwnProperty.call(this.data, id)) {
+    if (!Object.prototype.hasOwnProperty.call(this.data.node, id)) {
       throw new Error(`The tree attempted to reference node '${id}', but couldn't find the corresponding node.`);
     }
     return this.data.node[id];

package/dist/esm/index.js

@@ -693,7 +693,7 @@ var InMemoryStoreStrategy = class extends SerializeStrategy {
     return Math.ceil(Math.random() * Number.MAX_SAFE_INTEGER - 1);
   }
   read(id) {
-    if (Object.prototype.hasOwnProperty.call(this.data, id)) {
+    if (!Object.prototype.hasOwnProperty.call(this.data.node, id)) {
       throw new Error(`The tree attempted to reference node '${id}', but couldn't find the corresponding node.`);
     }
     return this.data.node[id];

package/dist/typings/SerializeStrategy.d.ts

@@ -30,7 +30,7 @@ export declare abstract class SerializeStrategy<K, V> {
      * It is called when a tree instance is created.
      * This method should return the information needed to initialize the tree. This information refers to the values stored in the `writeHead` method.
      *
-     * If it's the first creation and there are no saved root nodes, return `null`.
+     * If it is the initial creation and there is no stored head, it should return `null`.
      * In this case, the tree is created based on the order specified in the strategy instance constructor parameters.
      */
     abstract readHead(): SerializeStrategyHead | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serializable-bptree",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Store the B+tree flexibly, not only in-memory.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",