@blackglory/cache-js 0.9.2 → 0.10.0
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 +19 -12
- package/lib/cache-client.d.ts +10 -9
- package/lib/cache-client.js +6 -6
- package/lib/cache-client.js.map +1 -1
- package/lib/contract.d.ts +10 -10
- package/lib/contract.js +1 -1
- package/lib/contract.js.map +1 -1
- package/package.json +14 -14
package/README.md
CHANGED
|
@@ -9,12 +9,11 @@ yarn add @blackglory/cache-js
|
|
|
9
9
|
## API
|
|
10
10
|
### CacheClient
|
|
11
11
|
```ts
|
|
12
|
-
interface
|
|
13
|
-
namespace: string
|
|
12
|
+
interface INamespaceStats {
|
|
14
13
|
items: number
|
|
15
14
|
}
|
|
16
15
|
|
|
17
|
-
interface
|
|
16
|
+
interface IItemMetadata {
|
|
18
17
|
updatedAt: number
|
|
19
18
|
timeToLive: number | null
|
|
20
19
|
}
|
|
@@ -30,29 +29,37 @@ class CacheClient {
|
|
|
30
29
|
|
|
31
30
|
close(): Promise<void>
|
|
32
31
|
|
|
33
|
-
|
|
32
|
+
getNamespaceStats(namespace: string, timeout?: number): Promise<INamespaceStats>
|
|
33
|
+
|
|
34
34
|
getAllNamespaces(timeout?: number): Promise<string[]>
|
|
35
|
+
|
|
35
36
|
getAllItemKeys(namespace: string, timeout?: number): Promise<string[]>
|
|
36
37
|
|
|
37
38
|
hasItem(namespace: string, itemKey: string, timeout?: number): Promise<boolean>
|
|
38
39
|
|
|
39
|
-
getItem(namespace: string, itemKey: string, timeout?: number): Promise<
|
|
40
|
+
getItem(namespace: string, itemKey: string, timeout?: number): Promise<
|
|
41
|
+
{
|
|
42
|
+
value: JSONValue
|
|
43
|
+
metadata: IItemMetadata
|
|
44
|
+
} | null
|
|
45
|
+
>
|
|
40
46
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
47
|
+
getItemValue(
|
|
48
|
+
namespace: string
|
|
49
|
+
, itemKey: string
|
|
50
|
+
, timeout?: number
|
|
51
|
+
): Promise<JSONValue | null>
|
|
45
52
|
|
|
46
|
-
|
|
53
|
+
getItemValues(
|
|
47
54
|
namespace: string
|
|
48
55
|
, itemKeys: string[]
|
|
49
56
|
, timeout?: number
|
|
50
|
-
): Promise<Array<
|
|
57
|
+
): Promise<Array<JSONValue | null>>
|
|
51
58
|
|
|
52
59
|
setItem(
|
|
53
60
|
namespace: string
|
|
54
61
|
, itemKey: string
|
|
55
|
-
, itemValue:
|
|
62
|
+
, itemValue: JSONValue
|
|
56
63
|
, timeToLive: number | null
|
|
57
64
|
, timeout?: number
|
|
58
65
|
): Promise<void>
|
package/lib/cache-client.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import { INamespaceStats, IItemMetadata } from './contract.js';
|
|
2
|
+
import { JSONValue } from '@blackglory/prelude';
|
|
3
|
+
export { INamespaceStats, IItemMetadata } from './contract.js';
|
|
3
4
|
export interface ICacheClientOptions {
|
|
4
5
|
server: string;
|
|
5
6
|
timeout?: number;
|
|
@@ -14,17 +15,17 @@ export declare class CacheClient {
|
|
|
14
15
|
static create(options: ICacheClientOptions): Promise<CacheClient>;
|
|
15
16
|
private constructor();
|
|
16
17
|
close(): Promise<void>;
|
|
17
|
-
|
|
18
|
+
getNamespaceStats(namespace: string, timeout?: number): Promise<INamespaceStats>;
|
|
18
19
|
getAllNamespaces(timeout?: number): Promise<string[]>;
|
|
19
20
|
getAllItemKeys(namespace: string, timeout?: number): Promise<string[]>;
|
|
20
21
|
hasItem(namespace: string, itemKey: string, timeout?: number): Promise<boolean>;
|
|
21
|
-
getItem(namespace: string, itemKey: string, timeout?: number): Promise<
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
metadata: IMetadata;
|
|
22
|
+
getItem(namespace: string, itemKey: string, timeout?: number): Promise<{
|
|
23
|
+
value: JSONValue;
|
|
24
|
+
metadata: IItemMetadata;
|
|
25
25
|
} | null>;
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
getItemValue(namespace: string, itemKey: string, timeout?: number): Promise<JSONValue | null>;
|
|
27
|
+
getItemValues(namespace: string, itemKeys: string[], timeout?: number): Promise<Array<JSONValue | null>>;
|
|
28
|
+
setItem(namespace: string, itemKey: string, itemValue: JSONValue, timeToLive: number | null, timeout?: number): Promise<void>;
|
|
28
29
|
removeItem(namespace: string, itemKey: string, timeout?: number): Promise<void>;
|
|
29
30
|
clearItemsByNamespace(namespace: string, timeout?: number): Promise<void>;
|
|
30
31
|
private withTimeout;
|
package/lib/cache-client.js
CHANGED
|
@@ -15,8 +15,8 @@ export class CacheClient {
|
|
|
15
15
|
async close() {
|
|
16
16
|
await this.closeClients();
|
|
17
17
|
}
|
|
18
|
-
async
|
|
19
|
-
return await this.withTimeout(() => this.client.
|
|
18
|
+
async getNamespaceStats(namespace, timeout) {
|
|
19
|
+
return await this.withTimeout(() => this.client.getNamespaceStats(namespace), timeout !== null && timeout !== void 0 ? timeout : this.timeout);
|
|
20
20
|
}
|
|
21
21
|
async getAllNamespaces(timeout) {
|
|
22
22
|
return await this.withTimeout(() => this.client.getAllNamespaces(), timeout !== null && timeout !== void 0 ? timeout : this.timeout);
|
|
@@ -30,12 +30,12 @@ export class CacheClient {
|
|
|
30
30
|
async getItem(namespace, itemKey, timeout) {
|
|
31
31
|
return await this.withTimeout(() => this.client.getItem(namespace, itemKey), timeout !== null && timeout !== void 0 ? timeout : this.timeout);
|
|
32
32
|
}
|
|
33
|
-
async
|
|
34
|
-
return await this.withTimeout(() => this.client.
|
|
33
|
+
async getItemValue(namespace, itemKey, timeout) {
|
|
34
|
+
return await this.withTimeout(() => this.client.getItemValue(namespace, itemKey), timeout !== null && timeout !== void 0 ? timeout : this.timeout);
|
|
35
35
|
}
|
|
36
|
-
async
|
|
36
|
+
async getItemValues(namespace, itemKeys, timeout) {
|
|
37
37
|
return await this.withTimeout(async () => {
|
|
38
|
-
const results = await this.batchClient.parallel(...itemKeys.map(key => this.batchProxy.
|
|
38
|
+
const results = await this.batchClient.parallel(...itemKeys.map(key => this.batchProxy.getItemValue(namespace, key)));
|
|
39
39
|
return results.map(result => result.unwrap());
|
|
40
40
|
}, timeout !== null && timeout !== void 0 ? timeout : this.timeout);
|
|
41
41
|
}
|
package/lib/cache-client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache-client.js","sourceRoot":"","sources":["../src/cache-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,8BAA4B;AAGtD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"cache-client.js","sourceRoot":"","sources":["../src/cache-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,8BAA4B;AAGtD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAU5D,MAAM,OAAO,WAAW;IAMtB,YACU,MAAyB,EACzB,WAAwB,EACxB,UAA2C,EAC3C,YAAiC,EACjC,OAAgB;QAJhB,WAAM,GAAN,MAAM,CAAmB;QACzB,gBAAW,GAAX,WAAW,CAAa;QACxB,eAAU,GAAV,UAAU,CAAiC;QAC3C,iBAAY,GAAZ,YAAY,CAAqB;QACjC,YAAO,GAAP,OAAO,CAAS;IACvB,CAAC;IAXJ,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAA4B;QAC9C,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QACnF,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5E,CAAC;IAUD,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,YAAY,EAAE,CAAA;IAC3B,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,SAAiB,EACjB,OAAgB;QAEhB,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAC9C,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,OAAgB;QACrC,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,EACpC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,SAAiB,EAAE,OAAgB;QACtD,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,EAC3C,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CACX,SAAiB,EACjB,OAAe,EACf,OAAgB;QAEhB,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,EAC7C,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CACX,SAAiB,EACjB,OAAe,EACf,OAAgB;QAOhB,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,EAC7C,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,SAAiB,EACjB,OAAe,EACf,OAAgB;QAEhB,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,EAClD,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,SAAiB,EACjB,QAAkB,EAClB,OAAgB;QAEhB,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,KAAK,IAAI,EAAE;YACT,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC7C,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CACrE,CAAA;YACD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;QAC/C,CAAC,EACD,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CACX,SAAiB,EACjB,OAAe,EACf,SAAoB,EACpB,UAAyB,EACzB,OAAgB;QAEhB,MAAM,IAAI,CAAC,WAAW,CACpB,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CACvB,SAAS,EACT,OAAO,EACP,SAAS,EACT,UAAU,CACX,EACD,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,SAAiB,EACjB,OAAe,EACf,OAAgB;QAEhB,MAAM,IAAI,CAAC,WAAW,CACpB,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,EAChD,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,SAAiB,EAAE,OAAgB;QAC7D,MAAM,IAAI,CAAC,WAAW,CACpB,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,SAAS,CAAC,EAClD,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CACxB,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,EAAwB,EACxB,UAA8B,IAAI,CAAC,OAAO;QAE1C,IAAI,OAAO,EAAE;YACX,OAAO,MAAM,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAA;SACzD;aAAM;YACL,OAAO,MAAM,EAAE,EAAE,CAAA;SAClB;IACH,CAAC;CACF"}
|
package/lib/contract.d.ts
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
|
|
2
|
-
export
|
|
3
|
-
|
|
1
|
+
import { JSONValue } from '@blackglory/prelude';
|
|
2
|
+
export declare const expectedVersion = "^0.9.0";
|
|
3
|
+
export interface INamespaceStats {
|
|
4
4
|
items: number;
|
|
5
5
|
}
|
|
6
|
-
export interface
|
|
6
|
+
export interface IItemMetadata {
|
|
7
7
|
updatedAt: number;
|
|
8
8
|
timeToLive: number | null;
|
|
9
9
|
}
|
|
10
10
|
export interface IAPI {
|
|
11
|
-
stats(namespace: string): IStats;
|
|
12
11
|
getAllNamespaces(): string[];
|
|
13
12
|
getAllItemKeys(namespace: string): string[];
|
|
13
|
+
getNamespaceStats(namespace: string): INamespaceStats;
|
|
14
14
|
hasItem(namespace: string, itemKey: string): boolean;
|
|
15
|
-
getItem(namespace: string, itemKey: string):
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
metadata: IMetadata;
|
|
15
|
+
getItem(namespace: string, itemKey: string): {
|
|
16
|
+
value: JSONValue;
|
|
17
|
+
metadata: IItemMetadata;
|
|
19
18
|
} | null;
|
|
20
|
-
|
|
19
|
+
getItemValue(namespace: string, itemKey: string): JSONValue | null;
|
|
20
|
+
setItem(namespace: string, itemKey: string, itemValue: JSONValue, timeToLive: number | null): null;
|
|
21
21
|
removeItem(namespace: string, itemKey: string): null;
|
|
22
22
|
clearItemsByNamespace(namespace: string): null;
|
|
23
23
|
}
|
package/lib/contract.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const expectedVersion = '^0.
|
|
1
|
+
export const expectedVersion = '^0.9.0';
|
|
2
2
|
//# sourceMappingURL=contract.js.map
|
package/lib/contract.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,eAAe,GAAG,QAAQ,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blackglory/cache-js",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.10.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"keywords": [],
|
|
6
6
|
"files": [
|
|
@@ -43,17 +43,17 @@
|
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"@blackglory/jest-resolver": "^0.3.0",
|
|
46
|
-
"@commitlint/cli": "^17.
|
|
47
|
-
"@commitlint/config-conventional": "^17.4.
|
|
48
|
-
"@types/jest": "^29.
|
|
46
|
+
"@commitlint/cli": "^17.5.1",
|
|
47
|
+
"@commitlint/config-conventional": "^17.4.4",
|
|
48
|
+
"@types/jest": "^29.5.0",
|
|
49
49
|
"@types/ws": "^8.5.4",
|
|
50
|
-
"@typescript-eslint/eslint-plugin": "^5.
|
|
51
|
-
"@typescript-eslint/parser": "^5.
|
|
50
|
+
"@typescript-eslint/eslint-plugin": "^5.57.0",
|
|
51
|
+
"@typescript-eslint/parser": "^5.57.0",
|
|
52
52
|
"cross-env": "^7.0.3",
|
|
53
|
-
"eslint": "^8.
|
|
53
|
+
"eslint": "^8.36.0",
|
|
54
54
|
"husky": "4",
|
|
55
|
-
"jest": "^29.
|
|
56
|
-
"jest-resolve": "^29.
|
|
55
|
+
"jest": "^29.5.0",
|
|
56
|
+
"jest-resolve": "^29.5.0",
|
|
57
57
|
"npm-run-all": "^4.1.5",
|
|
58
58
|
"rimraf": "^3.0.2",
|
|
59
59
|
"standard-version": "^9.5.0",
|
|
@@ -65,12 +65,12 @@
|
|
|
65
65
|
},
|
|
66
66
|
"dependencies": {
|
|
67
67
|
"@blackglory/prelude": "^0.3.1",
|
|
68
|
-
"@delight-rpc/extra-native-websocket": "^0.
|
|
69
|
-
"@delight-rpc/extra-websocket": "^0.
|
|
70
|
-
"delight-rpc": "^
|
|
71
|
-
"extra-abort": "^0.3.
|
|
68
|
+
"@delight-rpc/extra-native-websocket": "^0.5.1",
|
|
69
|
+
"@delight-rpc/extra-websocket": "^0.6.1",
|
|
70
|
+
"delight-rpc": "^6.0.1",
|
|
71
|
+
"extra-abort": "^0.3.4",
|
|
72
72
|
"extra-native-websocket": "^0.3.1",
|
|
73
73
|
"extra-websocket": "^0.3.0",
|
|
74
|
-
"ws": "^8.
|
|
74
|
+
"ws": "^8.13.0"
|
|
75
75
|
}
|
|
76
76
|
}
|