inray 0.0.2 → 0.0.3

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.
Files changed (155) hide show
  1. package/LICENSE.md +1 -0
  2. package/README.md +132 -32
  3. package/dist/caching/mod.d.ts +2 -0
  4. package/dist/caching/mod.d.ts.map +1 -0
  5. package/dist/caching/mod.js +2 -0
  6. package/dist/caching/mod.js.map +1 -0
  7. package/dist/caching/src/cache.d.ts +89 -0
  8. package/dist/caching/src/cache.d.ts.map +1 -0
  9. package/dist/caching/src/cache.js +309 -0
  10. package/dist/caching/src/cache.js.map +1 -0
  11. package/dist/caching/src/hashing/cache.d.ts +92 -0
  12. package/dist/caching/src/hashing/cache.d.ts.map +1 -0
  13. package/dist/caching/src/hashing/cache.js +119 -0
  14. package/dist/caching/src/hashing/cache.js.map +1 -0
  15. package/dist/caching/src/hashing/hooks/eventified.d.ts +157 -0
  16. package/dist/caching/src/hashing/hooks/eventified.d.ts.map +1 -0
  17. package/dist/caching/src/hashing/hooks/eventified.js +333 -0
  18. package/dist/caching/src/hashing/hooks/eventified.js.map +1 -0
  19. package/dist/caching/src/hashing/hooks/index.d.ts +199 -0
  20. package/dist/caching/src/hashing/hooks/index.d.ts.map +1 -0
  21. package/dist/caching/src/hashing/hooks/index.js +383 -0
  22. package/dist/caching/src/hashing/hooks/index.js.map +1 -0
  23. package/dist/caching/src/hashing/hooks/types.d.ts +217 -0
  24. package/dist/caching/src/hashing/hooks/types.d.ts.map +1 -0
  25. package/dist/caching/src/hashing/hooks/types.js +10 -0
  26. package/dist/caching/src/hashing/hooks/types.js.map +1 -0
  27. package/dist/caching/src/hashing/index.d.ts +236 -0
  28. package/dist/caching/src/hashing/index.d.ts.map +1 -0
  29. package/dist/caching/src/hashing/index.js +447 -0
  30. package/dist/caching/src/hashing/index.js.map +1 -0
  31. package/dist/caching/src/hashing/providers/crc.d.ts +15 -0
  32. package/dist/caching/src/hashing/providers/crc.d.ts.map +1 -0
  33. package/dist/caching/src/hashing/providers/crc.js +49 -0
  34. package/dist/caching/src/hashing/providers/crc.js.map +1 -0
  35. package/dist/caching/src/hashing/providers/crypto.d.ts +19 -0
  36. package/dist/caching/src/hashing/providers/crypto.d.ts.map +1 -0
  37. package/dist/caching/src/hashing/providers/crypto.js +28 -0
  38. package/dist/caching/src/hashing/providers/crypto.js.map +1 -0
  39. package/dist/caching/src/hashing/providers/djb2.d.ts +60 -0
  40. package/dist/caching/src/hashing/providers/djb2.d.ts.map +1 -0
  41. package/dist/caching/src/hashing/providers/djb2.js +92 -0
  42. package/dist/caching/src/hashing/providers/djb2.js.map +1 -0
  43. package/dist/caching/src/hashing/providers/fnv1.d.ts +33 -0
  44. package/dist/caching/src/hashing/providers/fnv1.d.ts.map +1 -0
  45. package/dist/caching/src/hashing/providers/fnv1.js +68 -0
  46. package/dist/caching/src/hashing/providers/fnv1.js.map +1 -0
  47. package/dist/caching/src/hashing/providers/murmur.d.ts +81 -0
  48. package/dist/caching/src/hashing/providers/murmur.d.ts.map +1 -0
  49. package/dist/caching/src/hashing/providers/murmur.js +173 -0
  50. package/dist/caching/src/hashing/providers/murmur.js.map +1 -0
  51. package/dist/caching/src/hashing/providers.d.ts +126 -0
  52. package/dist/caching/src/hashing/providers.d.ts.map +1 -0
  53. package/dist/caching/src/hashing/providers.js +163 -0
  54. package/dist/caching/src/hashing/providers.js.map +1 -0
  55. package/dist/caching/src/hashing/types.d.ts +340 -0
  56. package/dist/caching/src/hashing/types.d.ts.map +1 -0
  57. package/dist/caching/src/hashing/types.js +10 -0
  58. package/dist/caching/src/hashing/types.js.map +1 -0
  59. package/dist/caching/src/keyValue/capabilities.d.ts +161 -0
  60. package/dist/caching/src/keyValue/capabilities.d.ts.map +1 -0
  61. package/dist/caching/src/keyValue/capabilities.js +334 -0
  62. package/dist/caching/src/keyValue/capabilities.js.map +1 -0
  63. package/dist/caching/src/keyValue/event-manager.d.ts +27 -0
  64. package/dist/caching/src/keyValue/event-manager.d.ts.map +1 -0
  65. package/dist/caching/src/keyValue/event-manager.js +88 -0
  66. package/dist/caching/src/keyValue/event-manager.js.map +1 -0
  67. package/dist/caching/src/keyValue/generic-store.d.ts +243 -0
  68. package/dist/caching/src/keyValue/generic-store.d.ts.map +1 -0
  69. package/dist/caching/src/keyValue/generic-store.js +295 -0
  70. package/dist/caching/src/keyValue/generic-store.js.map +1 -0
  71. package/dist/caching/src/keyValue/hooks-manager.d.ts +21 -0
  72. package/dist/caching/src/keyValue/hooks-manager.d.ts.map +1 -0
  73. package/dist/caching/src/keyValue/hooks-manager.js +59 -0
  74. package/dist/caching/src/keyValue/hooks-manager.js.map +1 -0
  75. package/dist/caching/src/keyValue/index.d.ts +334 -0
  76. package/dist/caching/src/keyValue/index.d.ts.map +1 -0
  77. package/dist/caching/src/keyValue/index.js +796 -0
  78. package/dist/caching/src/keyValue/index.js.map +1 -0
  79. package/dist/caching/src/keyValue/serialize/serialize.d.ts +12 -0
  80. package/dist/caching/src/keyValue/serialize/serialize.d.ts.map +1 -0
  81. package/dist/caching/src/keyValue/serialize/serialize.js +64 -0
  82. package/dist/caching/src/keyValue/serialize/serialize.js.map +1 -0
  83. package/dist/caching/src/keyValue/stats-manager.d.ts +27 -0
  84. package/dist/caching/src/keyValue/stats-manager.d.ts.map +1 -0
  85. package/dist/caching/src/keyValue/stats-manager.js +64 -0
  86. package/dist/caching/src/keyValue/stats-manager.js.map +1 -0
  87. package/dist/caching/src/keyValue/types.d.ts +22 -0
  88. package/dist/caching/src/keyValue/types.d.ts.map +1 -0
  89. package/dist/caching/src/keyValue/types.js +11 -0
  90. package/dist/caching/src/keyValue/types.js.map +1 -0
  91. package/dist/caching/src/keyv-adapter.d.ts +40 -0
  92. package/dist/caching/src/keyv-adapter.d.ts.map +1 -0
  93. package/dist/caching/src/keyv-adapter.js +56 -0
  94. package/dist/caching/src/keyv-adapter.js.map +1 -0
  95. package/dist/caching/src/utils/cache-tags.d.ts +275 -0
  96. package/dist/caching/src/utils/cache-tags.d.ts.map +1 -0
  97. package/dist/caching/src/utils/cache-tags.js +407 -0
  98. package/dist/caching/src/utils/cache-tags.js.map +1 -0
  99. package/dist/caching/src/utils/cacheable-item-types.d.ts +35 -0
  100. package/dist/caching/src/utils/cacheable-item-types.d.ts.map +1 -0
  101. package/dist/caching/src/utils/cacheable-item-types.js +10 -0
  102. package/dist/caching/src/utils/cacheable-item-types.js.map +1 -0
  103. package/dist/caching/src/utils/coalesce-async.d.ts +29 -0
  104. package/dist/caching/src/utils/coalesce-async.d.ts.map +1 -0
  105. package/dist/caching/src/utils/coalesce-async.js +88 -0
  106. package/dist/caching/src/utils/coalesce-async.js.map +1 -0
  107. package/dist/caching/src/utils/hash.d.ts +55 -0
  108. package/dist/caching/src/utils/hash.d.ts.map +1 -0
  109. package/dist/caching/src/utils/hash.js +116 -0
  110. package/dist/caching/src/utils/hash.js.map +1 -0
  111. package/dist/caching/src/utils/index.d.ts +24 -0
  112. package/dist/caching/src/utils/index.d.ts.map +1 -0
  113. package/dist/caching/src/utils/index.js +21 -0
  114. package/dist/caching/src/utils/index.js.map +1 -0
  115. package/dist/caching/src/utils/is-keyv-instance.d.ts +10 -0
  116. package/dist/caching/src/utils/is-keyv-instance.d.ts.map +1 -0
  117. package/dist/caching/src/utils/is-keyv-instance.js +37 -0
  118. package/dist/caching/src/utils/is-keyv-instance.js.map +1 -0
  119. package/dist/caching/src/utils/is-object.d.ts +10 -0
  120. package/dist/caching/src/utils/is-object.d.ts.map +1 -0
  121. package/dist/caching/src/utils/is-object.js +13 -0
  122. package/dist/caching/src/utils/is-object.js.map +1 -0
  123. package/dist/caching/src/utils/less-than.d.ts +10 -0
  124. package/dist/caching/src/utils/less-than.d.ts.map +1 -0
  125. package/dist/caching/src/utils/less-than.js +13 -0
  126. package/dist/caching/src/utils/less-than.js.map +1 -0
  127. package/dist/caching/src/utils/memoize.d.ts +107 -0
  128. package/dist/caching/src/utils/memoize.d.ts.map +1 -0
  129. package/dist/caching/src/utils/memoize.js +201 -0
  130. package/dist/caching/src/utils/memoize.js.map +1 -0
  131. package/dist/caching/src/utils/mock-cacheable.d.ts +28 -0
  132. package/dist/caching/src/utils/mock-cacheable.d.ts.map +1 -0
  133. package/dist/caching/src/utils/mock-cacheable.js +87 -0
  134. package/dist/caching/src/utils/mock-cacheable.js.map +1 -0
  135. package/dist/caching/src/utils/run-if-fn.d.ts +12 -0
  136. package/dist/caching/src/utils/run-if-fn.d.ts.map +1 -0
  137. package/dist/caching/src/utils/run-if-fn.js +12 -0
  138. package/dist/caching/src/utils/run-if-fn.js.map +1 -0
  139. package/dist/caching/src/utils/shorthand-time.d.ts +27 -0
  140. package/dist/caching/src/utils/shorthand-time.d.ts.map +1 -0
  141. package/dist/caching/src/utils/shorthand-time.js +96 -0
  142. package/dist/caching/src/utils/shorthand-time.js.map +1 -0
  143. package/dist/caching/src/utils/sleep.d.ts +10 -0
  144. package/dist/caching/src/utils/sleep.d.ts.map +1 -0
  145. package/dist/caching/src/utils/sleep.js +11 -0
  146. package/dist/caching/src/utils/sleep.js.map +1 -0
  147. package/dist/caching/src/utils/stats.d.ts +354 -0
  148. package/dist/caching/src/utils/stats.d.ts.map +1 -0
  149. package/dist/caching/src/utils/stats.js +593 -0
  150. package/dist/caching/src/utils/stats.js.map +1 -0
  151. package/dist/caching/src/utils/ttl.d.ts +58 -0
  152. package/dist/caching/src/utils/ttl.d.ts.map +1 -0
  153. package/dist/caching/src/utils/ttl.js +77 -0
  154. package/dist/caching/src/utils/ttl.js.map +1 -0
  155. package/package.json +11 -3
@@ -0,0 +1,334 @@
1
+ /**
2
+ * Original library: keyv (v5.6.0)
3
+ * - Copyright (c) 2017-2021 Luke Childs
4
+ * - Copyright (c) 2021-2022 Jared Wray
5
+ *
6
+ * Modified and integrated in "Inray":
7
+ * - Evgeniy Bushin
8
+ */
9
+ /***/
10
+ import EventManager from './event-manager.js';
11
+ import HooksManager from './hooks-manager.js';
12
+ import StatsManager from './stats-manager.js';
13
+ export type DeserializedData<Value> = {
14
+ value?: Value;
15
+ expires?: number | undefined;
16
+ };
17
+ export type CompressionAdapter = {
18
+ compress(value: any, options?: any): Promise<any>;
19
+ decompress(value: any, options?: any): Promise<any>;
20
+ serialize<Value>(data: DeserializedData<Value>): Promise<string> | string;
21
+ deserialize<Value>(data: string): Promise<DeserializedData<Value> | undefined> | DeserializedData<Value> | undefined;
22
+ };
23
+ export type Serialize = <Value>(data: DeserializedData<Value>) => Promise<string> | string;
24
+ export type Deserialize = <Value>(data: string) => Promise<DeserializedData<Value> | undefined> | DeserializedData<Value> | undefined;
25
+ export type KeyvHook = 'preSet' | 'postSet' | 'preGet' | 'postGet' | 'preGetMany' | 'postGetMany' | 'preGetRaw' | 'postGetRaw' | 'preGetManyRaw' | 'postGetManyRaw' | 'preDelete' | 'postDelete';
26
+ export type KeyvEntry = {
27
+ /**
28
+ * Key to set.
29
+ */
30
+ key: string;
31
+ /**
32
+ * Value to set.
33
+ */
34
+ value: any;
35
+ /**
36
+ * Time to live in milliseconds.
37
+ */
38
+ ttl?: number;
39
+ };
40
+ export type StoredDataNoRaw<Value> = Value | undefined;
41
+ export type StoredDataRaw<Value> = DeserializedData<Value> | undefined;
42
+ export type StoredData<Value> = StoredDataNoRaw<Value> | StoredDataRaw<Value>;
43
+ export type IEventEmitter = {
44
+ on(event: string, listener: (...arguments_: any[]) => void): IEventEmitter;
45
+ };
46
+ export type KeyvStoreAdapter = {
47
+ opts: any;
48
+ namespace?: string | undefined;
49
+ get<Value>(key: string): Promise<StoredData<Value> | undefined>;
50
+ set(key: string, value: any, ttl?: number): any;
51
+ setMany?(values: Array<{
52
+ key: string;
53
+ value: any;
54
+ ttl?: number;
55
+ }>): Promise<void>;
56
+ delete(key: string): Promise<boolean>;
57
+ clear(): Promise<void>;
58
+ has?(key: string): Promise<boolean>;
59
+ hasMany?(keys: string[]): Promise<boolean[]>;
60
+ getMany?<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
61
+ disconnect?(): Promise<void>;
62
+ deleteMany?(key: string[]): Promise<boolean>;
63
+ iterator?<Value>(namespace?: string): AsyncGenerator<Array<string | Awaited<Value> | undefined>, void>;
64
+ } & IEventEmitter;
65
+ export type KeyvOptions = {
66
+ /**
67
+ * Emit errors
68
+ * @default true
69
+ */
70
+ emitErrors?: boolean;
71
+ /**
72
+ * Namespace for the current instance.
73
+ * @default 'keyv'
74
+ */
75
+ namespace?: string;
76
+ /**
77
+ * A custom serialization function.
78
+ * @default defaultSerialize using JSON.stringify
79
+ */
80
+ serialize?: Serialize;
81
+ /**
82
+ * A custom deserialization function.
83
+ * @default defaultDeserialize using JSON.parse
84
+ */
85
+ deserialize?: Deserialize;
86
+ /**
87
+ * The storage adapter instance to be used by Keyv.
88
+ * @default new Map() - in-memory store
89
+ */
90
+ store?: KeyvStoreAdapter | Map<any, any> | any;
91
+ /**
92
+ * Default TTL in milliseconds. Can be overridden by specifying a TTL on `.set()`.
93
+ * @default undefined
94
+ */
95
+ ttl?: number;
96
+ /**
97
+ * Enable compression option
98
+ * @default false
99
+ */
100
+ compression?: CompressionAdapter | any;
101
+ /**
102
+ * Enable or disable statistics (default is false)
103
+ * @default false
104
+ */
105
+ stats?: boolean;
106
+ /**
107
+ * Enable or disable key prefixing (default is true)
108
+ * @default true
109
+ */
110
+ useKeyPrefix?: boolean;
111
+ /**
112
+ * Will enable throwing errors on methods in addition to emitting them.
113
+ * @default false
114
+ */
115
+ throwOnErrors?: boolean;
116
+ };
117
+ type KeyvOptions_ = Omit<KeyvOptions, 'store'> & {
118
+ store: KeyvStoreAdapter | (Map<any, any> & KeyvStoreAdapter);
119
+ };
120
+ type IteratorFunction = (argument: any) => AsyncGenerator<any, void>;
121
+ export declare class Keyv<GenericValue = any> extends EventManager {
122
+ opts: KeyvOptions_;
123
+ iterator?: IteratorFunction;
124
+ hooks: HooksManager;
125
+ stats: StatsManager;
126
+ /**
127
+ * Time to live in milliseconds
128
+ */
129
+ private _ttl?;
130
+ /**
131
+ * Namespace
132
+ */
133
+ private _namespace?;
134
+ /**
135
+ * Store
136
+ */
137
+ private _store;
138
+ private _serialize;
139
+ private _deserialize;
140
+ private _compression;
141
+ private _useKeyPrefix;
142
+ private _throwOnErrors;
143
+ /**
144
+ * Keyv Constructor
145
+ * @param {KeyvStoreAdapter | KeyvOptions | Map<any, any>} store to be provided or just the options
146
+ * @param {Omit<KeyvOptions, 'store'>} [options] if you provide the store you can then provide the Keyv Options
147
+ */
148
+ constructor(store?: KeyvStoreAdapter | KeyvOptions | Map<any, any>, options?: Omit<KeyvOptions, 'store'>);
149
+ /**
150
+ * Keyv Constructor
151
+ * @param {KeyvOptions} options to be provided
152
+ */
153
+ constructor(options?: KeyvOptions);
154
+ /**
155
+ * Get the current store
156
+ */
157
+ get store(): KeyvStoreAdapter | Map<any, any> | any;
158
+ /**
159
+ * Set the current store. This will also set the namespace, event error handler, and generate the iterator. If the store is not valid it will throw an error.
160
+ * @param {KeyvStoreAdapter | Map<any, any> | any} store the store to set
161
+ */
162
+ set store(store: KeyvStoreAdapter | Map<any, any> | any);
163
+ /**
164
+ * Get the current compression function
165
+ * @returns {CompressionAdapter} The current compression function
166
+ */
167
+ get compression(): CompressionAdapter | undefined;
168
+ /**
169
+ * Set the current compression function
170
+ * @param {CompressionAdapter} compress The compression function to set
171
+ */
172
+ set compression(compress: CompressionAdapter | undefined);
173
+ /**
174
+ * Get the current namespace.
175
+ * @returns {string | undefined} The current namespace.
176
+ */
177
+ get namespace(): string | undefined;
178
+ /**
179
+ * Set the current namespace.
180
+ * @param {string | undefined} namespace The namespace to set.
181
+ */
182
+ set namespace(namespace: string | undefined);
183
+ /**
184
+ * Get the current TTL.
185
+ * @returns {number} The current TTL in milliseconds.
186
+ */
187
+ get ttl(): number | undefined;
188
+ /**
189
+ * Set the current TTL.
190
+ * @param {number} ttl The TTL to set in milliseconds.
191
+ */
192
+ set ttl(ttl: number | undefined);
193
+ /**
194
+ * Get the current serialize function.
195
+ * @returns {Serialize} The current serialize function.
196
+ */
197
+ get serialize(): Serialize | undefined;
198
+ /**
199
+ * Set the current serialize function.
200
+ * @param {Serialize} serialize The serialize function to set.
201
+ */
202
+ set serialize(serialize: Serialize | undefined);
203
+ /**
204
+ * Get the current deserialize function.
205
+ * @returns {Deserialize} The current deserialize function.
206
+ */
207
+ get deserialize(): Deserialize | undefined;
208
+ /**
209
+ * Set the current deserialize function.
210
+ * @param {Deserialize} deserialize The deserialize function to set.
211
+ */
212
+ set deserialize(deserialize: Deserialize | undefined);
213
+ /**
214
+ * Get the current useKeyPrefix value. This will enable or disable key prefixing.
215
+ * @returns {boolean} The current useKeyPrefix value.
216
+ * @default true
217
+ */
218
+ get useKeyPrefix(): boolean;
219
+ /**
220
+ * Set the current useKeyPrefix value. This will enable or disable key prefixing.
221
+ * @param {boolean} value The useKeyPrefix value to set.
222
+ */
223
+ set useKeyPrefix(value: boolean);
224
+ /**
225
+ * Get the current throwErrors value. This will enable or disable throwing errors on methods in addition to emitting them.
226
+ * @return {boolean} The current throwOnErrors value.
227
+ */
228
+ get throwOnErrors(): boolean;
229
+ /**
230
+ * Set the current throwOnErrors value. This will enable or disable throwing errors on methods in addition to emitting them.
231
+ * @param {boolean} value The throwOnErrors value to set.
232
+ */
233
+ set throwOnErrors(value: boolean);
234
+ generateIterator(iterator: IteratorFunction): IteratorFunction;
235
+ _checkIterableAdapter(): boolean;
236
+ _getKeyPrefix(key: string): string;
237
+ _getKeyPrefixArray(keys: string[]): string[];
238
+ _getKeyUnprefix(key: string): string;
239
+ _isValidStorageAdapter(store: KeyvStoreAdapter | any): boolean;
240
+ /**
241
+ * Get the Value of a Key
242
+ * @param {string | string[]} key passing in a single key or multiple as an array
243
+ * @param {{raw: boolean} | undefined} options can pass in to return the raw value by setting { raw: true }
244
+ */
245
+ get<Value = GenericValue>(key: string, options?: {
246
+ raw: false;
247
+ }): Promise<StoredDataNoRaw<Value>>;
248
+ get<Value = GenericValue>(key: string, options?: {
249
+ raw: true;
250
+ }): Promise<StoredDataRaw<Value>>;
251
+ get<Value = GenericValue>(key: string[], options?: {
252
+ raw: false;
253
+ }): Promise<Array<StoredDataNoRaw<Value>>>;
254
+ get<Value = GenericValue>(key: string[], options?: {
255
+ raw: true;
256
+ }): Promise<Array<StoredDataRaw<Value>>>;
257
+ /**
258
+ * Get many values of keys
259
+ * @param {string[]} keys passing in a single key or multiple as an array
260
+ * @param {{raw: boolean} | undefined} options can pass in to return the raw value by setting { raw: true }
261
+ */
262
+ getMany<Value = GenericValue>(keys: string[], options?: {
263
+ raw: false;
264
+ }): Promise<Array<StoredDataNoRaw<Value>>>;
265
+ getMany<Value = GenericValue>(keys: string[], options?: {
266
+ raw: true;
267
+ }): Promise<Array<StoredDataRaw<Value>>>;
268
+ /**
269
+ * Get the raw value of a key. This is the replacement for setting raw to true in the get() method.
270
+ * @param {string} key the key to get
271
+ * @returns {Promise<StoredDataRaw<Value> | undefined>} will return a StoredDataRaw<Value> or undefined if the key does not exist or is expired.
272
+ */
273
+ getRaw<Value = GenericValue>(key: string): Promise<StoredDataRaw<Value> | undefined>;
274
+ /**
275
+ * Get the raw values of many keys. This is the replacement for setting raw to true in the getMany() method.
276
+ * @param {string[]} keys the keys to get
277
+ * @returns {Promise<Array<StoredDataRaw<Value>>>} will return an array of StoredDataRaw<Value> or undefined if the key does not exist or is expired.
278
+ */
279
+ getManyRaw<Value = GenericValue>(keys: string[]): Promise<Array<StoredDataRaw<Value>>>;
280
+ /**
281
+ * Set an item to the store
282
+ * @param {string | Array<KeyvEntry>} key the key to use. If you pass in an array of KeyvEntry it will set many items
283
+ * @param {Value} value the value of the key
284
+ * @param {number} [ttl] time to live in milliseconds
285
+ * @returns {boolean} if it sets then it will return a true. On failure will return false.
286
+ */
287
+ set<Value = GenericValue>(key: string, value: Value, ttl?: number): Promise<boolean>;
288
+ /**
289
+ * Set many items to the store
290
+ * @param {Array<KeyvEntry>} entries the entries to set
291
+ * @returns {boolean[]} will return an array of booleans if it sets then it will return a true. On failure will return false.
292
+ */
293
+ setMany<Value = GenericValue>(entries: KeyvEntry[]): Promise<boolean[]>;
294
+ /**
295
+ * Delete an Entry
296
+ * @param {string | string[]} key the key to be deleted. if an array it will delete many items
297
+ * @returns {boolean} will return true if item or items are deleted. false if there is an error
298
+ */
299
+ delete(key: string | string[]): Promise<boolean>;
300
+ /**
301
+ * Delete many items from the store
302
+ * @param {string[]} keys the keys to be deleted
303
+ * @returns {boolean} will return true if item or items are deleted. false if there is an error
304
+ */
305
+ deleteMany(keys: string[]): Promise<boolean>;
306
+ /**
307
+ * Clear the store
308
+ * @returns {void}
309
+ */
310
+ clear(): Promise<void>;
311
+ /**
312
+ * Has a key
313
+ * @param {string} key the key to check
314
+ * @returns {boolean} will return true if the key exists
315
+ */
316
+ has(key: string[]): Promise<boolean[]>;
317
+ has(key: string): Promise<boolean>;
318
+ /**
319
+ * Check if many keys exist
320
+ * @param {string[]} keys the keys to check
321
+ * @returns {boolean[]} will return an array of booleans if the keys exist
322
+ */
323
+ hasMany(keys: string[]): Promise<boolean[]>;
324
+ /**
325
+ * Will disconnect the store. This is only available if the store has a disconnect method
326
+ * @returns {Promise<void>}
327
+ */
328
+ disconnect(): Promise<void>;
329
+ emit(event: string, ...arguments_: any[]): void;
330
+ serializeData<T>(data: DeserializedData<T>): Promise<string | DeserializedData<T>>;
331
+ deserializeData<T>(data: string | DeserializedData<T>): Promise<DeserializedData<T> | undefined>;
332
+ }
333
+ export default Keyv;
334
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/caching/src/keyValue/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,KAAK;AAGL,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,MAAM,MAAM,gBAAgB,CAAC,KAAK,IAAI;IACpC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAElD,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACpD,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC1E,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;CACtH,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAE3F,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAC9B,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;AAiBxF,MAAM,MAAM,QAAQ,GAChB,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,SAAS,GACT,YAAY,GACZ,aAAa,GACb,WAAW,GACX,YAAY,GACZ,eAAe,GACf,gBAAgB,GAChB,WAAW,GACX,YAAY,CAAC;AAEjB,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IAEH,KAAK,EAAE,GAAG,CAAC;IACX;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,KAAK,IAAI,KAAK,GAAG,SAAS,CAAC;AAEvD,MAAM,MAAM,aAAa,CAAC,KAAK,IAAI,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;AAEvE,MAAM,MAAM,UAAU,CAAC,KAAK,IAAI,eAAe,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;AAE9E,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,UAAU,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,aAAa,CAAC;CAC5E,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC;IAEhE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IAChD,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClF,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,OAAO,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7C,OAAO,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAC/E,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,UAAU,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;CACxG,GAAG,aAAa,CAAC;AAElB,MAAM,MAAM,WAAW,GAAG;IACxB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;;OAGG;IAEH,KAAK,CAAC,EAAE,gBAAgB,GAAG,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC;IAC/C;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IAEH,WAAW,CAAC,EAAE,kBAAkB,GAAG,GAAG,CAAC;IACvC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,KAAK,YAAY,GAAG,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG;IAC/C,KAAK,EAAE,gBAAgB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAC;CAC9D,CAAC;AAEF,KAAK,gBAAgB,GAAG,CAAC,QAAQ,EAAE,GAAG,KAAK,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AAIrE,qBAAa,IAAI,CAAC,YAAY,GAAG,GAAG,CAAE,SAAQ,YAAY;IACxD,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,KAAK,eAAsB;IAC3B,KAAK,eAA2B;IAEhC;;OAEG;IACH,OAAO,CAAC,IAAI,CAAC,CAAS;IAEtB;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAAS;IAE5B;;OAEG;IAEH,OAAO,CAAC,MAAM,CAAqD;IAEnE,OAAO,CAAC,UAAU,CAA2C;IAC7D,OAAO,CAAC,YAAY,CAA+C;IAEnE,OAAO,CAAC,YAAY,CAAiC;IAErD,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,cAAc,CAAS;IAE/B;;;;OAIG;gBACS,KAAK,CAAC,EAAE,gBAAgB,GAAG,WAAW,GAAG,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC;IACxG;;;OAGG;gBACS,OAAO,CAAC,EAAE,WAAW;IAqFjC;;OAEG;IAEH,IAAW,KAAK,IAAI,gBAAgB,GAAG,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,CAEzD;IAED;;;OAGG;IAEH,IAAW,KAAK,CAAC,KAAK,EAAE,gBAAgB,GAAG,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,EAsB7D;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,kBAAkB,GAAG,SAAS,CAEvD;IAED;;;OAGG;IACH,IAAW,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,SAAS,EAE9D;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,MAAM,GAAG,SAAS,CAEzC;IAED;;;OAGG;IACH,IAAW,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAQjD;IAED;;;OAGG;IACH,IAAW,GAAG,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED;;;OAGG;IACH,IAAW,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAGrC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAE5C;IAED;;;OAGG;IACH,IAAW,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAGpD;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,WAAW,GAAG,SAAS,CAEhD;IAED;;;OAGG;IACH,IAAW,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,SAAS,EAG1D;IAED;;;;OAIG;IACH,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED;;;OAGG;IACH,IAAW,YAAY,CAAC,KAAK,EAAE,OAAO,EAGrC;IAED;;;OAGG;IACH,IAAW,aAAa,IAAI,OAAO,CAElC;IAED;;;OAGG;IACH,IAAW,aAAa,CAAC,KAAK,EAAE,OAAO,EAGtC;IAED,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,gBAAgB;IAoB9D,qBAAqB,IAAI,OAAO;IAOhC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAiBlC,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAY5C,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAQpC,sBAAsB,CAAC,KAAK,EAAE,gBAAgB,GAAG,GAAG,GAAG,OAAO;IAU9D;;;;OAIG;IACG,GAAG,CAAC,KAAK,GAAG,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACjG,GAAG,CAAC,KAAK,GAAG,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9F,GAAG,CAAC,KAAK,GAAG,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1G,GAAG,CAAC,KAAK,GAAG,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IAgE7G;;;;OAIG;IACU,OAAO,CAAC,KAAK,GAAG,YAAY,EACvC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,KAAK,CAAA;KAAE,GACvB,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5B,OAAO,CAAC,KAAK,GAAG,YAAY,EACvC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,IAAI,CAAA;KAAE,GACtB,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IAsFvC;;;;OAIG;IACU,MAAM,CAAC,KAAK,GAAG,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAiDjG;;;;OAIG;IACU,UAAU,CAAC,KAAK,GAAG,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IAuEnG;;;;;;OAMG;IACG,GAAG,CAAC,KAAK,GAAG,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiD1F;;;;OAIG;IACG,OAAO,CAAC,KAAK,GAAG,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAqD7E;;;;OAIG;IACU,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAmC7D;;;;OAIG;IACU,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA6BzD;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAc5B;;;;OAIG;IACU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IACtC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAwC/C;;;;OAIG;IACU,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAgBxD;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ1B,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI;IAQzC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAelF,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CAmB9G;AAED,eAAe,IAAI,CAAC"}