@blackglory/cache-js 0.10.0 → 0.10.2
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 -12
- package/lib/cache-client.d.ts +3 -6
- package/lib/cache-client.js +1 -1
- package/lib/cache-client.js.map +1 -1
- package/lib/contract.d.ts +5 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,21 +9,26 @@ yarn add @blackglory/cache-js
|
|
|
9
9
|
## API
|
|
10
10
|
### CacheClient
|
|
11
11
|
```ts
|
|
12
|
+
interface ICacheClientOptions {
|
|
13
|
+
server: string
|
|
14
|
+
timeout?: number
|
|
15
|
+
retryIntervalForReconnection?: number
|
|
16
|
+
}
|
|
17
|
+
|
|
12
18
|
interface INamespaceStats {
|
|
13
19
|
items: number
|
|
14
20
|
}
|
|
15
21
|
|
|
22
|
+
interface IItem {
|
|
23
|
+
value: JSONValue
|
|
24
|
+
metadata: IItemMetadata
|
|
25
|
+
}
|
|
26
|
+
|
|
16
27
|
interface IItemMetadata {
|
|
17
28
|
updatedAt: number
|
|
18
29
|
timeToLive: number | null
|
|
19
30
|
}
|
|
20
31
|
|
|
21
|
-
interface ICacheClientOptions {
|
|
22
|
-
server: string
|
|
23
|
-
timeout?: number
|
|
24
|
-
retryIntervalForReconnection?: number
|
|
25
|
-
}
|
|
26
|
-
|
|
27
32
|
class CacheClient {
|
|
28
33
|
static create(options: ICacheClientOptions): Promise<CacheClient>
|
|
29
34
|
|
|
@@ -37,12 +42,11 @@ class CacheClient {
|
|
|
37
42
|
|
|
38
43
|
hasItem(namespace: string, itemKey: string, timeout?: number): Promise<boolean>
|
|
39
44
|
|
|
40
|
-
getItem(
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
>
|
|
45
|
+
getItem(
|
|
46
|
+
namespace: string
|
|
47
|
+
, itemKey: string
|
|
48
|
+
, timeout?: number
|
|
49
|
+
): Promise<IItem | null>
|
|
46
50
|
|
|
47
51
|
getItemValue(
|
|
48
52
|
namespace: string
|
package/lib/cache-client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { INamespaceStats,
|
|
1
|
+
import { INamespaceStats, IItem } from './contract.js';
|
|
2
2
|
import { JSONValue } from '@blackglory/prelude';
|
|
3
|
-
export { INamespaceStats, IItemMetadata } from './contract.js';
|
|
3
|
+
export { INamespaceStats, IItem, IItemMetadata } from './contract.js';
|
|
4
4
|
export interface ICacheClientOptions {
|
|
5
5
|
server: string;
|
|
6
6
|
timeout?: number;
|
|
@@ -19,10 +19,7 @@ export declare class CacheClient {
|
|
|
19
19
|
getAllNamespaces(timeout?: number): Promise<string[]>;
|
|
20
20
|
getAllItemKeys(namespace: string, timeout?: number): Promise<string[]>;
|
|
21
21
|
hasItem(namespace: string, itemKey: string, timeout?: number): Promise<boolean>;
|
|
22
|
-
getItem(namespace: string, itemKey: string, timeout?: number): Promise<
|
|
23
|
-
value: JSONValue;
|
|
24
|
-
metadata: IItemMetadata;
|
|
25
|
-
} | null>;
|
|
22
|
+
getItem(namespace: string, itemKey: string, timeout?: number): Promise<IItem | null>;
|
|
26
23
|
getItemValue(namespace: string, itemKey: string, timeout?: number): Promise<JSONValue | null>;
|
|
27
24
|
getItemValues(namespace: string, itemKeys: string[], timeout?: number): Promise<Array<JSONValue | null>>;
|
|
28
25
|
setItem(namespace: string, itemKey: string, itemValue: JSONValue, timeToLive: number | null, timeout?: number): Promise<void>;
|
package/lib/cache-client.js
CHANGED
|
@@ -9,7 +9,7 @@ export class CacheClient {
|
|
|
9
9
|
this.timeout = timeout;
|
|
10
10
|
}
|
|
11
11
|
static async create(options) {
|
|
12
|
-
const { client, batchClient, proxy, close } = await createRPCClient(options.server);
|
|
12
|
+
const { client, batchClient, proxy, close } = await createRPCClient(options.server, options.retryIntervalForReconnection);
|
|
13
13
|
return new CacheClient(client, batchClient, proxy, close, options.timeout);
|
|
14
14
|
}
|
|
15
15
|
async close() {
|
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;AAU5D,MAAM,OAAO,WAAW;
|
|
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;IAStB,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;IAdJ,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAA4B;QAC9C,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,eAAe,CACjE,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,4BAA4B,CACrC,CAAA;QACD,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;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,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
|
@@ -3,6 +3,10 @@ export declare const expectedVersion = "^0.9.0";
|
|
|
3
3
|
export interface INamespaceStats {
|
|
4
4
|
items: number;
|
|
5
5
|
}
|
|
6
|
+
export interface IItem {
|
|
7
|
+
value: JSONValue;
|
|
8
|
+
metadata: IItemMetadata;
|
|
9
|
+
}
|
|
6
10
|
export interface IItemMetadata {
|
|
7
11
|
updatedAt: number;
|
|
8
12
|
timeToLive: number | null;
|
|
@@ -12,10 +16,7 @@ export interface IAPI {
|
|
|
12
16
|
getAllItemKeys(namespace: string): string[];
|
|
13
17
|
getNamespaceStats(namespace: string): INamespaceStats;
|
|
14
18
|
hasItem(namespace: string, itemKey: string): boolean;
|
|
15
|
-
getItem(namespace: string, itemKey: string):
|
|
16
|
-
value: JSONValue;
|
|
17
|
-
metadata: IItemMetadata;
|
|
18
|
-
} | null;
|
|
19
|
+
getItem(namespace: string, itemKey: string): IItem | null;
|
|
19
20
|
getItemValue(namespace: string, itemKey: string): JSONValue | null;
|
|
20
21
|
setItem(namespace: string, itemKey: string, itemValue: JSONValue, timeToLive: number | null): null;
|
|
21
22
|
removeItem(namespace: string, itemKey: string): null;
|