serializable-bptree 5.1.0 → 5.1.2

package/dist/types/base/BPTree.d.ts

@@ -1,6 +1,6 @@
+import { CacheEntanglementSync, CacheEntanglementAsync, type StringValue } from 'cache-entanglement';
 import { ValueComparator } from './ValueComparator';
 import { SerializableData, SerializeStrategy } from './SerializeStrategy';
-import { InvertedWeakMap } from '../utils/InvertedWeakMap';
 type Sync<T> = T;
 type Async<T> = Promise<T>;
 type Deferred<T> = Sync<T> | Async<T>;
@@ -25,6 +25,17 @@ export type BPTreeCondition<V> = Partial<{
 }>;
 export type BPTreePair<K, V> = Map<K, V>;
 export type BPTreeUnknownNode<K, V> = BPTreeInternalNode<K, V> | BPTreeLeafNode<K, V>;
+export interface BPTreeConstructorOption {
+    /**
+     * The lifespan of the cached node.
+     * This value is used to determine how long a cached node should be kept in memory.
+     * If the lifespan is set to a positive number, the cached node will expire after the specified number of milliseconds.
+     * If the lifespan is set to `0` or a negative number, the cache will not prevent garbage collection.
+     * If the lifespan is set to a string, the string will be parsed as a time duration.
+     * For example, '1m' means 1 minute, '1h' means 1 hour, '1d' means 1 day, '1w' means 1 week.
+     */
+    lifespan?: StringValue | number;
+}
 export interface BPTreeNode<K, V> {
     id: string;
     keys: string[] | K[][];
@@ -44,9 +55,10 @@ export interface BPTreeLeafNode<K, V> extends BPTreeNode<K, V> {
 }
 export declare abstract class BPTree<K, V> {
     private readonly _cachedRegexp;
+    protected abstract readonly nodes: CacheEntanglementSync<any, any> | CacheEntanglementAsync<any, any>;
     protected readonly strategy: SerializeStrategy<K, V>;
     protected readonly comparator: ValueComparator<V>;
-    protected readonly nodes: InvertedWeakMap<string, BPTreeUnknownNode<K, V>>;
+    protected readonly option: BPTreeConstructorOption;
     protected order: number;
     protected root: BPTreeUnknownNode<K, V>;
     protected _strategyDirty: boolean;
@@ -57,7 +69,8 @@ export declare abstract class BPTree<K, V> {
     protected readonly verifierStartNode: Record<keyof BPTreeCondition<V>, (value: V) => Deferred<BPTreeLeafNode<K, V>>>;
     protected readonly verifierEndNode: Record<keyof BPTreeCondition<V>, (value: V) => Deferred<BPTreeLeafNode<K, V> | null>>;
     protected readonly verifierDirection: Record<keyof BPTreeCondition<V>, -1 | 1>;
-    protected constructor(strategy: SerializeStrategy<K, V>, comparator: ValueComparator<V>);
+    protected constructor(strategy: SerializeStrategy<K, V>, comparator: ValueComparator<V>, option?: BPTreeConstructorOption);
+    private _createCachedRegexp;
     protected abstract getPairsRightToLeft(value: V, startNode: BPTreeLeafNode<K, V>, endNode: BPTreeLeafNode<K, V> | null, comparator: (nodeValue: V, value: V) => boolean): Deferred<BPTreePair<K, V>>;
     protected abstract getPairsLeftToRight(value: V, startNode: BPTreeLeafNode<K, V>, endNode: BPTreeLeafNode<K, V> | null, comparator: (nodeValue: V, value: V) => boolean): Deferred<BPTreePair<K, V>>;
     protected abstract getPairs(value: V, startNode: BPTreeLeafNode<K, V>, endNode: BPTreeLeafNode<K, V> | null, comparator: (nodeValue: V, value: V) => boolean, direction: -1 | 1): Deferred<BPTreePair<K, V>>;
@@ -140,5 +153,10 @@ export declare abstract class BPTree<K, V> {
      * @returns User-defined data stored in the head of the tree.
      */
     getHeadData(): SerializableData;
+    /**
+     * Clears all cached nodes.
+     * This method is useful for freeing up memory when the tree is no longer needed.
+     */
+    clear(): void;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serializable-bptree",
-  "version": "5.1.0",
+  "version": "5.1.2",
   "description": "Store the B+tree flexibly, not only in-memory.",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.cjs",
@@ -37,9 +37,12 @@
   "license": "MIT",
   "devDependencies": {
     "@types/jest": "^29.5.14",
-    "esbuild": "^0.25.4",
+    "esbuild": "^0.25.5",
     "jest": "^29.7.0",
-    "ts-jest": "^29.3.3",
+    "ts-jest": "^29.3.4",
     "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "cache-entanglement": "^1.5.4"
   }
 }

package/dist/types/utils/InvertedWeakMap.d.ts

@@ -1,12 +0,0 @@
-export declare class InvertedWeakMap<K extends string | number | symbol, V extends WeakKey> {
-    private readonly _map;
-    private readonly _registry;
-    constructor();
-    clear(): void;
-    delete(key: K): boolean;
-    get(key: K): V | undefined;
-    has(key: K): boolean;
-    set(key: K, value: V): this;
-    get size(): number;
-    keys(): IterableIterator<K>;
-}