webext-storage 0.0.0 → 1.0.0

package/distribution/storage-item.d.ts

@@ -8,5 +8,6 @@ export declare class StorageItem<T> {
     constructor(key: string, { area }?: StorageItemOptions);
     get(): Promise<T | undefined>;
     set(value: T): Promise<void>;
+    remove(): Promise<void>;
     onChange(callback: (value: T) => void, signal?: AbortSignal): void;
 }

package/distribution/storage-item.js

@@ -17,6 +17,9 @@ export class StorageItem {
     async set(value) {
         await chromeP.storage[this.area].set({ [this.key]: value });
     }
+    async remove() {
+        await chromeP.storage[this.area].remove(this.key);
+    }
     onChange(callback, signal) {
         const changeHandler = (changes, area) => {
             console.log('changeHandler', changes, area);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "webext-storage",
-	"version": "0.0.0",
+	"version": "1.0.0",
 	"description": "A more usable typed storage API for Web Extensions",
 	"keywords": [
 		"browser",
@@ -25,7 +25,8 @@
 	"main": "./distribution/storage-item.js",
 	"types": "./distribution/storage-item.d.ts",
 	"files": [
-		"distribution"
+		"distribution/storage-item.js",
+		"distribution/storage-item.d.ts"
 	],
 	"scripts": {
 		"build": "tsc",

package/readme.md

@@ -5,6 +5,13 @@
 
 > A more usable typed storage API for Web Extensions
 
+- Browsers: Chrome, Firefox, and Safari
+- Manifest: v2 and v3
+- Permissions: `storage` or `unlimitedStorage`
+- Context: They can be called from any context
+
+**Sponsored by [PixieBrix](https://www.pixiebrix.com)** :tada:
+
 ## Install
 
 ```sh
@@ -26,6 +33,9 @@ await username.set('Ugo');
 await username.get();
 // Promise<string>
 
+await username.remove();
+// Promise<void>
+
 await username.set({name: 'Ugo'});
 // TypeScript Error: Argument of type '{ name: string; }' is not assignable to parameter of type 'string'.
 

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

@@ -1 +0,0 @@
-export {};

package/distribution/storage-item.test-d.js

@@ -1,25 +0,0 @@
-/* eslint-disable no-new -- Type tests only */
-import { expectType, expectNotAssignable, expectAssignable } from 'tsd';
-import { StorageItem } from './storage-item.js';
-new StorageItem('key', { area: 'local' });
-new StorageItem('key', { area: 'sync' });
-const unknownItem = new StorageItem('key');
-expectAssignable(unknownItem.get());
-const objectItem = new StorageItem('key');
-expectType(objectItem.get());
-expectType(objectItem.set({ name: 'new name' }));
-const stringItem = new StorageItem('key');
-expectAssignable(stringItem.get());
-expectNotAssignable(stringItem.get());
-expectType(stringItem.get());
-expectType(stringItem.set('some string'));
-// @ts-expect-error Type is string
-await stringItem.set(1);
-// @ts-expect-error Type is string
-await stringItem.set(true);
-// @ts-expect-error Type is string
-await stringItem.set([true, 'string']);
-// @ts-expect-error Type is string
-await stringItem.set({ wow: [true, 'string'] });
-// @ts-expect-error Type is string
-await stringItem.set(1, { days: 1 });