keyv 5.0.2 → 5.1.0

package/README.md

@@ -50,6 +50,36 @@ First, create a new Keyv instance.
 import Keyv from 'keyv';
 ```
 
+### Type-safe Usage
+
+You can create a `Keyv` instance with a generic type to enforce type safety for the values stored. Additionally, both the `get` and `set` methods support specifying custom types for specific use cases.
+
+#### Example with Instance-level Generic Type:
+
+```ts
+const keyv = new Keyv<number>(); // Instance handles only numbers
+await keyv.set('key1', 123);
+const value = await keyv.get('key1'); // value is inferred as number
+```
+
+#### Example with Method-level Generic Type:
+
+You can also specify a type directly in the `get` or `set` methods, allowing flexibility for different types of values within the same instance.
+
+```ts
+const keyv = new Keyv(); // Generic type not specified at instance level
+
+await keyv.set<string>('key2', 'some string'); // Method-level type for this value
+const strValue = await keyv.get<string>('key2'); // Explicitly typed as string
+
+await keyv.set<number>('key3', 456); // Storing a number in the same instance
+const numValue = await keyv.get<number>('key3'); // Explicitly typed as number
+```
+
+This makes `Keyv` highly adaptable to different data types while maintaining type safety.
+
+### Using Storage Adapters
+
 Once you have created your Keyv instance you can use it as a simple key-value store with `in-memory` by default. To use a storage adapter, create an instance of the adapter and pass it to the Keyv constructor. Here are some examples:
 
 ```js
@@ -434,4 +464,4 @@ We welcome contributions to Keyv! 🎉 Here are some guides to get you started w
 
 # License
 
-[MIT © Jared Wray](LICENSE)
+[MIT © Jared Wray](LICENSE)

package/dist/index.cjs

@@ -389,10 +389,10 @@ var Keyv = class extends event_manager_default {
     if (typeof value === "symbol") {
       this.emit("error", "symbol cannot be serialized");
     }
-    value = { value, expires };
-    value = await this.opts.serialize(value);
-    await store.set(keyPrefixed, value, ttl);
-    this.hooks.trigger("postSet" /* POST_SET */, { key: keyPrefixed, value, ttl });
+    const formattedValue = { value, expires };
+    const serializedValue = await this.opts.serialize(formattedValue);
+    await store.set(keyPrefixed, serializedValue, ttl);
+    this.hooks.trigger("postSet" /* POST_SET */, { key: keyPrefixed, value: serializedValue, ttl });
     this.stats.set();
     return true;
   }

package/dist/index.d.cts

@@ -41,7 +41,7 @@ declare class StatsManager extends EventManager {
 
 type DeserializedData<Value> = {
     value?: Value;
-    expires?: number;
+    expires?: number | null;
 };
 interface CompressionAdapter {
     compress(value: any, options?: any): Promise<any>;
@@ -63,7 +63,7 @@ type StoredDataNoRaw<Value> = Value | undefined;
 type StoredDataRaw<Value> = DeserializedData<Value> | undefined;
 type StoredData<Value> = StoredDataNoRaw<Value> | StoredDataRaw<Value>;
 interface IEventEmitter {
-    on(event: string, listener: (...arguments_: any[]) => void): void;
+    on(event: string, listener: (...arguments_: any[]) => void): this;
 }
 interface KeyvStoreAdapter extends IEventEmitter {
     opts: any;
@@ -100,7 +100,7 @@ type KeyvOptions_ = Omit<KeyvOptions, 'store'> & {
     store: KeyvStoreAdapter | Map<any, any> & KeyvStoreAdapter;
 };
 type IteratorFunction = (argument: any) => AsyncGenerator<any, void>;
-declare class Keyv extends EventManager {
+declare class Keyv<GenericValue = any> extends EventManager {
     opts: KeyvOptions_;
     iterator?: IteratorFunction;
     hooks: HooksManager;
@@ -113,19 +113,19 @@ declare class Keyv extends EventManager {
     _getKeyPrefixArray(keys: string[]): string[];
     _getKeyUnprefix(key: string): string;
     _isValidStorageAdapter(store: KeyvStoreAdapter | any): boolean;
-    get<Value>(key: string, options?: {
+    get<Value = GenericValue>(key: string, options?: {
         raw: false;
     }): Promise<StoredDataNoRaw<Value>>;
-    get<Value>(key: string, options?: {
+    get<Value = GenericValue>(key: string, options?: {
         raw: true;
     }): Promise<StoredDataRaw<Value>>;
-    get<Value>(key: string[], options?: {
+    get<Value = GenericValue>(key: string[], options?: {
         raw: false;
     }): Promise<Array<StoredDataNoRaw<Value>>>;
-    get<Value>(key: string[], options?: {
+    get<Value = GenericValue>(key: string[], options?: {
         raw: true;
     }): Promise<Array<StoredDataRaw<Value>>>;
-    set(key: string, value: any, ttl?: number): Promise<boolean>;
+    set<Value = GenericValue>(key: string, value: Value, ttl?: number): Promise<boolean>;
     delete(key: string | string[]): Promise<boolean>;
     clear(): Promise<void>;
     has(key: string): Promise<boolean>;

package/dist/index.d.ts

@@ -41,7 +41,7 @@ declare class StatsManager extends EventManager {
 
 type DeserializedData<Value> = {
     value?: Value;
-    expires?: number;
+    expires?: number | null;
 };
 interface CompressionAdapter {
     compress(value: any, options?: any): Promise<any>;
@@ -63,7 +63,7 @@ type StoredDataNoRaw<Value> = Value | undefined;
 type StoredDataRaw<Value> = DeserializedData<Value> | undefined;
 type StoredData<Value> = StoredDataNoRaw<Value> | StoredDataRaw<Value>;
 interface IEventEmitter {
-    on(event: string, listener: (...arguments_: any[]) => void): void;
+    on(event: string, listener: (...arguments_: any[]) => void): this;
 }
 interface KeyvStoreAdapter extends IEventEmitter {
     opts: any;
@@ -100,7 +100,7 @@ type KeyvOptions_ = Omit<KeyvOptions, 'store'> & {
     store: KeyvStoreAdapter | Map<any, any> & KeyvStoreAdapter;
 };
 type IteratorFunction = (argument: any) => AsyncGenerator<any, void>;
-declare class Keyv extends EventManager {
+declare class Keyv<GenericValue = any> extends EventManager {
     opts: KeyvOptions_;
     iterator?: IteratorFunction;
     hooks: HooksManager;
@@ -113,19 +113,19 @@ declare class Keyv extends EventManager {
     _getKeyPrefixArray(keys: string[]): string[];
     _getKeyUnprefix(key: string): string;
     _isValidStorageAdapter(store: KeyvStoreAdapter | any): boolean;
-    get<Value>(key: string, options?: {
+    get<Value = GenericValue>(key: string, options?: {
         raw: false;
     }): Promise<StoredDataNoRaw<Value>>;
-    get<Value>(key: string, options?: {
+    get<Value = GenericValue>(key: string, options?: {
         raw: true;
     }): Promise<StoredDataRaw<Value>>;
-    get<Value>(key: string[], options?: {
+    get<Value = GenericValue>(key: string[], options?: {
         raw: false;
     }): Promise<Array<StoredDataNoRaw<Value>>>;
-    get<Value>(key: string[], options?: {
+    get<Value = GenericValue>(key: string[], options?: {
         raw: true;
     }): Promise<Array<StoredDataRaw<Value>>>;
-    set(key: string, value: any, ttl?: number): Promise<boolean>;
+    set<Value = GenericValue>(key: string, value: Value, ttl?: number): Promise<boolean>;
     delete(key: string | string[]): Promise<boolean>;
     clear(): Promise<void>;
     has(key: string): Promise<boolean>;

package/dist/index.js

@@ -363,10 +363,10 @@ var Keyv = class extends event_manager_default {
     if (typeof value === "symbol") {
       this.emit("error", "symbol cannot be serialized");
     }
-    value = { value, expires };
-    value = await this.opts.serialize(value);
-    await store.set(keyPrefixed, value, ttl);
-    this.hooks.trigger("postSet" /* POST_SET */, { key: keyPrefixed, value, ttl });
+    const formattedValue = { value, expires };
+    const serializedValue = await this.opts.serialize(formattedValue);
+    await store.set(keyPrefixed, serializedValue, ttl);
+    this.hooks.trigger("postSet" /* POST_SET */, { key: keyPrefixed, value: serializedValue, ttl });
     this.stats.set();
     return true;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "keyv",
-	"version": "5.0.2",
+	"version": "5.1.0",
 	"description": "Simple key-value storage with support for multiple backends",
 	"type": "module",
 	"main": "dist/index.cjs",