node-persist-manager 1.0.3 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -9
- package/dist/nodeStorage.d.ts +9 -0
- package/dist/nodeStorage.d.ts.map +1 -1
- package/dist/nodeStorage.js +17 -1
- package/dist/nodeStorage.js.map +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,4 +1,9 @@
|
|
|
1
|
-
# NodeStorage
|
|
1
|
+
# NodeStorageManager and NodeStorage
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/node-persist-manager)
|
|
4
|
+
[](https://www.npmjs.com/package/node-persist-manager)
|
|
5
|
+
|
|
6
|
+
---
|
|
2
7
|
|
|
3
8
|
NodeStorage is a lightweight, file-based storage management system for Node.js, built on top of `node-persist`. It allows for easy and intuitive handling of persistent key-value storage directly within your Node.js applications. This system is ideal for small to medium-sized projects requiring simple data persistence without the overhead of a database system.
|
|
4
9
|
|
|
@@ -82,24 +87,26 @@ await myStorage.clear();
|
|
|
82
87
|
|
|
83
88
|
## NodeStorageManager methods:
|
|
84
89
|
|
|
85
|
-
- createStorage(storageName: string): Promise<NodeStorage>
|
|
90
|
+
- async createStorage(storageName: string): Promise<NodeStorage>
|
|
91
|
+
|
|
92
|
+
- async removeStorage(storageName: string): Promise<boolean>
|
|
86
93
|
|
|
87
|
-
-
|
|
94
|
+
- async logStorage(): Promise<void>
|
|
88
95
|
|
|
89
|
-
-
|
|
96
|
+
- async getStorageNames(): Promise<NodeStorageName[]>
|
|
90
97
|
|
|
91
98
|
|
|
92
99
|
## NodeStorage methods:
|
|
93
100
|
|
|
94
|
-
- set<T = any>(key: NodeStorageKey, value: T): Promise<void>
|
|
101
|
+
- async set<T = any>(key: NodeStorageKey, value: T): Promise<void>
|
|
95
102
|
|
|
96
|
-
- get<T = any>(key: NodeStorageKey, defaultValue?: T): Promise<T>
|
|
103
|
+
- async get<T = any>(key: NodeStorageKey, defaultValue?: T): Promise<T>
|
|
97
104
|
|
|
98
|
-
- remove(key: NodeStorageKey): Promise<void>
|
|
105
|
+
- async remove(key: NodeStorageKey): Promise<void>
|
|
99
106
|
|
|
100
|
-
- clear(): Promise<void>
|
|
107
|
+
- async clear(): Promise<void>
|
|
101
108
|
|
|
102
|
-
- logStorage(): Promise<void>
|
|
109
|
+
- async logStorage(): Promise<void>
|
|
103
110
|
|
|
104
111
|
# Contributing
|
|
105
112
|
|
package/dist/nodeStorage.d.ts
CHANGED
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import NodePersist, { LocalStorage, InitOptions } from 'node-persist';
|
|
13
13
|
export type NodeStorageKey = string;
|
|
14
14
|
export type NodeStorageName = string;
|
|
15
|
+
export { InitOptions } from 'node-persist';
|
|
15
16
|
/**
|
|
16
17
|
* Class responsible for managing multiple node storages.
|
|
17
18
|
*/
|
|
@@ -24,6 +25,10 @@ export declare class NodeStorageManager {
|
|
|
24
25
|
* @param {InitOptions} [initOptions] - Optional initialization options to customize the storage.
|
|
25
26
|
*/
|
|
26
27
|
constructor(initOptions?: InitOptions);
|
|
28
|
+
/**
|
|
29
|
+
* Closes the node storage manager by stopping the expired keys interval and the write queue interval.
|
|
30
|
+
*/
|
|
31
|
+
close(): Promise<void>;
|
|
27
32
|
/**
|
|
28
33
|
* Creates and initializes a new storage with a given name.
|
|
29
34
|
* @param {string} storageName - The name of the new storage to create.
|
|
@@ -58,6 +63,10 @@ export declare class NodeStorage {
|
|
|
58
63
|
* @param {InitOptions} initOptions - The initialization options.
|
|
59
64
|
*/
|
|
60
65
|
constructor(storage: LocalStorage, initOptions: InitOptions);
|
|
66
|
+
/**
|
|
67
|
+
* Closes the node storage by stopping the expired keys interval and the write queue interval.
|
|
68
|
+
*/
|
|
69
|
+
close(): Promise<void>;
|
|
61
70
|
/**
|
|
62
71
|
* Sets a value for a given key in the storage.
|
|
63
72
|
* @template T - The type of the value to be stored.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nodeStorage.d.ts","sourceRoot":"","sources":["../src/nodeStorage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,WAAW,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAItE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"nodeStorage.d.ts","sourceRoot":"","sources":["../src/nodeStorage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,WAAW,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAItE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,YAAY,CAAuB;IAE3C;;;OAGG;gBACS,WAAW,CAAC,EAAE,WAAW;IAoBrC;;OAEG;IACG,KAAK;IAKX;;;;OAIG;IACG,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAoB9D;;;;OAIG;IACG,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB1D;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAKnD;;OAEG;IACG,UAAU;CAOjB;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAE1C;;;;OAIG;gBACS,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW;IAK3D;;OAEG;IACG,KAAK;IAKX;;;;;;OAMG;IAEG,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC;IAIvF;;;;;;;OAOG;IAEG,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAKrE;;;;OAIG;IACG,QAAQ,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAKrD;;;;OAIG;IACG,MAAM,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC;IAIxE;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;OAEG;IACG,UAAU;CAOjB"}
|
package/dist/nodeStorage.js
CHANGED
|
@@ -32,13 +32,22 @@ export class NodeStorageManager {
|
|
|
32
32
|
// Create and initialize a new instace of LocalStorage
|
|
33
33
|
this.storage = NodePersist.create(this.initOptions);
|
|
34
34
|
this.storage.initSync(this.initOptions);
|
|
35
|
-
|
|
35
|
+
if (this.initOptions.logging === true) {
|
|
36
|
+
console.log(`Storage manager initialized with options ${JSON.stringify(this.initOptions)}`);
|
|
37
|
+
}
|
|
36
38
|
/*
|
|
37
39
|
this.get<Array<NodeStorageName>>('storageNames').then(storageNames => {
|
|
38
40
|
this.storageNames = storageNames;
|
|
39
41
|
});
|
|
40
42
|
*/
|
|
41
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* Closes the node storage manager by stopping the expired keys interval and the write queue interval.
|
|
46
|
+
*/
|
|
47
|
+
async close() {
|
|
48
|
+
this.storage.stopExpiredKeysInterval();
|
|
49
|
+
this.storage.stopWriteQueueInterval();
|
|
50
|
+
}
|
|
42
51
|
/**
|
|
43
52
|
* Creates and initializes a new storage with a given name.
|
|
44
53
|
* @param {string} storageName - The name of the new storage to create.
|
|
@@ -120,6 +129,13 @@ export class NodeStorage {
|
|
|
120
129
|
this.storage = storage;
|
|
121
130
|
this.initOptions = initOptions;
|
|
122
131
|
}
|
|
132
|
+
/**
|
|
133
|
+
* Closes the node storage by stopping the expired keys interval and the write queue interval.
|
|
134
|
+
*/
|
|
135
|
+
async close() {
|
|
136
|
+
this.storage.stopExpiredKeysInterval();
|
|
137
|
+
this.storage.stopWriteQueueInterval();
|
|
138
|
+
}
|
|
123
139
|
/**
|
|
124
140
|
* Sets a value for a given key in the storage.
|
|
125
141
|
* @template T - The type of the value to be stored.
|
package/dist/nodeStorage.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nodeStorage.js","sourceRoot":"","sources":["../src/nodeStorage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,WAA0C,MAAM,cAAc,CAAC;AACtE,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AACjC,OAAO,IAAI,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"nodeStorage.js","sourceRoot":"","sources":["../src/nodeStorage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,WAA0C,MAAM,cAAc,CAAC;AACtE,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AACjC,OAAO,IAAI,MAAM,MAAM,CAAC;AAMxB;;GAEG;AACH,MAAM,OAAO,kBAAkB;IACZ,OAAO,CAAe;IACtB,WAAW,CAAc;IAClC,YAAY,GAAoB,EAAE,CAAC;IAE3C;;;OAGG;IACH,YAAY,WAAyB;QACnC,6CAA6C;QAC7C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;YAC/B,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC;YAC7C,OAAO,EAAE,KAAK;SACA,EAAE,WAAW,CAAC,CAAC;QAE/B,sDAAsD;QACtD,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxC,IAAG,IAAI,CAAC,WAAW,CAAC,OAAO,KAAG,IAAI,EAAE,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,4CAA4C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC9F,CAAC;QACD;;;;cAIA;IACF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,WAAmB;QACrC,MAAM,WAAW,GAAgB,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAI,EAAE,GAAG,GAAG,WAAW,CAAC,EAAiB,CAAC,CAAC;QAC1H,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChC,4FAA4F;QAE5F,sBAAsB;QACtB,IAAI,CAAC,YAAY,GAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QAC/D,qDAAqD;QACrD,IAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;QACD,qDAAqD;QACrD,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1D,2EAA2E;QAE3E,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,WAAmB;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAI,EAAE,GAAG,GAAG,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACnC,iCAAiC;YAEjC,sBAAsB;YACtB,IAAI,CAAC,YAAY,GAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;gBACf,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACrC,CAAC;YACD,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YAC1D,wEAAwE;YAExE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,gDAAgD;YAChD,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe;QACnB,IAAI,CAAC,YAAY,GAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAsB,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QACrF,YAAY,CAAC,OAAO,CAAE,IAAI,CAAC,EAAE;YAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,WAAW;IACL,OAAO,CAAe;IACtB,WAAW,CAAc;IAE1C;;;;OAIG;IACH,YAAY,OAAqB,EAAE,WAAwB;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,8DAA8D;IAC9D,KAAK,CAAC,GAAG,CAAU,GAAmB,EAAE,KAAQ;QAC9C,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,8DAA8D;IAC9D,KAAK,CAAC,GAAG,CAAU,GAAmB,EAAE,YAAgB;QACtD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,KAAK,KAAG,SAAS,CAAC,CAAC,CAAC,KAAK,CAAA,CAAC,CAAC,YAAY,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAmB;QAChC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,GAAmB;QAC9B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,CAAC,GAAG,CAAC,wBAAwB,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAC,GAAG,EAAC,EAAE;YACvB,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,KAAK,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "node-persist-manager",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.5",
|
|
4
4
|
"description": "Asyncronous Node.js storage manager in type script",
|
|
5
5
|
"author": "https://github.com/Luligu",
|
|
6
6
|
"license": "MIT",
|
|
@@ -42,14 +42,14 @@
|
|
|
42
42
|
],
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"@types/jest": "^29.5.12",
|
|
45
|
-
"@types/node": "^20.11.
|
|
45
|
+
"@types/node": "^20.11.28",
|
|
46
46
|
"@types/node-persist": "^3.1.8",
|
|
47
|
-
"@typescript-eslint/eslint-plugin": "^7.0
|
|
48
|
-
"@typescript-eslint/parser": "^7.0
|
|
49
|
-
"eslint": "^8.
|
|
47
|
+
"@typescript-eslint/eslint-plugin": "^7.2.0",
|
|
48
|
+
"@typescript-eslint/parser": "^7.2.0",
|
|
49
|
+
"eslint": "^8.57.0",
|
|
50
50
|
"jest": "^29.7.0",
|
|
51
51
|
"ts-jest": "^29.1.2",
|
|
52
|
-
"typescript": "^5.
|
|
52
|
+
"typescript": "^5.4.2"
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
55
|
"node-persist": "^4.0.1"
|