webext-storage 1.3.1 → 2.0.0

package/distribution/storage-item-map.d.ts

@@ -12,10 +12,11 @@ Return = Base | undefined> {
     readonly defaultValue?: Return;
     constructor(key: string, { area, defaultValue, }?: StorageItemMapOptions<Exclude<Return, undefined>>);
     has: (secondaryKey: string) => Promise<boolean>;
-    delete: (secondaryKey: string) => Promise<void>;
     get: (secondaryKey: string) => Promise<Return>;
     set: (secondaryKey: string, value: Exclude<Return, undefined>) => Promise<void>;
     remove: (secondaryKey: string) => Promise<void>;
+    /** @deprecated Only here to match the Map API; use `remove` instead */
+    delete: (secondaryKey: string) => Promise<void>;
     onChanged(callback: (key: string, value: Exclude<Return, undefined>) => void, signal?: AbortSignal): void;
     private getRawStorageKey;
     private getSecondaryStorageKey;

package/distribution/storage-item-map.js

@@ -11,11 +11,7 @@ export class StorageItemMap {
     has = async (secondaryKey) => {
         const rawStorageKey = this.getRawStorageKey(secondaryKey);
         const result = await chromeP.storage[this.areaName].get(rawStorageKey);
-        return Object.hasOwn(result, secondaryKey);
-    };
-    delete = async (secondaryKey) => {
-        const rawStorageKey = this.getRawStorageKey(secondaryKey);
-        await chromeP.storage[this.areaName].remove(rawStorageKey);
+        return Object.hasOwn(result, rawStorageKey);
     };
     get = async (secondaryKey) => {
         const rawStorageKey = this.getRawStorageKey(secondaryKey);
@@ -28,12 +24,21 @@ export class StorageItemMap {
     };
     set = async (secondaryKey, value) => {
         const rawStorageKey = this.getRawStorageKey(secondaryKey);
-        await chromeP.storage[this.areaName].set({ [rawStorageKey]: value });
+        // eslint-disable-next-line unicorn/prefer-ternary -- ur rong
+        if (value === undefined) {
+            await chromeP.storage[this.areaName].remove(rawStorageKey);
+        }
+        else {
+            await chromeP.storage[this.areaName].set({ [rawStorageKey]: value });
+        }
     };
     remove = async (secondaryKey) => {
         const rawStorageKey = this.getRawStorageKey(secondaryKey);
         await chromeP.storage[this.areaName].remove(rawStorageKey);
     };
+    /** @deprecated Only here to match the Map API; use `remove` instead */
+    // eslint-disable-next-line @typescript-eslint/member-ordering -- invalid
+    delete = this.remove;
     onChanged(callback, signal) {
         const changeHandler = (changes, area) => {
             if (area !== this.areaName) {

package/distribution/storage-item.d.ts

@@ -15,6 +15,7 @@ Return = Base | undefined> {
     constructor(key: string, { area, defaultValue, }?: StorageItemOptions<Exclude<Return, undefined>>);
     get: () => Promise<Return>;
     set: (value: Exclude<Return, undefined>) => Promise<void>;
+    has: () => Promise<boolean>;
     remove: () => Promise<void>;
     onChanged(callback: (value: Exclude<Return, undefined>) => void, signal?: AbortSignal): void;
 }

package/distribution/storage-item.js

@@ -19,7 +19,17 @@ export class StorageItem {
         return result[this.key];
     };
     set = async (value) => {
-        await chromeP.storage[this.area].set({ [this.key]: value });
+        // eslint-disable-next-line unicorn/prefer-ternary -- ur rong
+        if (value === undefined) {
+            await chromeP.storage[this.area].remove(this.key);
+        }
+        else {
+            await chromeP.storage[this.area].set({ [this.key]: value });
+        }
+    };
+    has = async () => {
+        const result = await chromeP.storage[this.area].get(this.key);
+        return Object.hasOwn(result, this.key);
     };
     remove = async () => {
         await chromeP.storage[this.area].remove(this.key);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "webext-storage",
-	"version": "1.3.1",
+	"version": "2.0.0",
 	"description": "A more usable typed storage API for Web Extensions",
 	"keywords": [
 		"browser",

package/readme.md

@@ -24,6 +24,7 @@ options.onChanged(newValue => {
 - `item.get()` returns the raw value instead of an object
 - Every `get` and `set` operation is type-safe
 - If you provide a `defaultValue`, the return type will not be ` | undefined`
+- Calling `.set(undefined)` will unset the value instead of the call being ignored
 - The `onChanged` example speaks for itself
 
 Now compare it to the native API: