webext-storage 1.0.0 → 1.1.0

package/distribution/storage-item.d.ts

@@ -1,13 +1,15 @@
 /// <reference types="chrome" />
-export type StorageItemOptions = {
+export type StorageItemOptions<T> = {
     area?: chrome.storage.AreaName;
+    defaultValue?: T;
 };
-export declare class StorageItem<T> {
+export declare class StorageItem<Base, InferredBase extends (Base | undefined) = Base | undefined, Return = InferredBase extends undefined ? Base | undefined : InferredBase> {
     readonly key: string;
     readonly area: chrome.storage.AreaName;
-    constructor(key: string, { area }?: StorageItemOptions);
-    get(): Promise<T | undefined>;
-    set(value: T): Promise<void>;
+    readonly defaultValue?: InferredBase;
+    constructor(key: string, { area, defaultValue, }?: StorageItemOptions<NonNullable<InferredBase>>);
+    get(): Promise<Return>;
+    set(value: NonNullable<InferredBase>): Promise<void>;
     remove(): Promise<void>;
-    onChange(callback: (value: T) => void, signal?: AbortSignal): void;
+    onChange(callback: (value: NonNullable<InferredBase>) => void, signal?: AbortSignal): void;
 }

package/distribution/storage-item.js

@@ -2,14 +2,16 @@ import chromeP from 'webext-polyfill-kinda';
 export class StorageItem {
     key;
     area;
-    constructor(key, { area = 'local' } = {}) {
+    defaultValue;
+    constructor(key, { area = 'local', defaultValue, } = {}) {
         this.key = key;
         this.area = area;
+        this.defaultValue = defaultValue;
     }
     async get() {
         const result = await chromeP.storage[this.area].get(this.key);
         if (!Object.hasOwn(result, this.key)) {
-            return;
+            return this.defaultValue;
         }
         // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- Assumes the user never uses the Storage API directly
         return result[this.key];
@@ -22,7 +24,6 @@ export class StorageItem {
     }
     onChange(callback, signal) {
         const changeHandler = (changes, area) => {
-            console.log('changeHandler', changes, area);
             const changedItem = changes[this.key];
             if (area === this.area && changedItem) {
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- Assumes the user never uses the Storage API directly
@@ -32,6 +33,8 @@ export class StorageItem {
         chrome.storage.onChanged.addListener(changeHandler);
         signal?.addEventListener('abort', () => {
             chrome.storage.onChanged.removeListener(changeHandler);
-        }, { once: true });
+        }, {
+            once: true,
+        });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "webext-storage",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"description": "A more usable typed storage API for Web Extensions",
 	"keywords": [
 		"browser",
@@ -52,7 +52,7 @@
 		"@types/sinon-chrome": "^2.2.13",
 		"jest-chrome": "^0.8.0",
 		"sinon-chrome": "^3.0.1",
-		"tsd": "^0.28.1",
+		"tsd": "^0.29.0",
 		"typescript": "^5.2.2",
 		"vitest": "^0.34.6",
 		"xo": "^0.56.0"

package/readme.md

@@ -26,6 +26,8 @@ Or download the [standalone bundle](https://bundle.fregante.com/?pkg=webext-stor
 import {StorageItem} from "webext-storage";
 
 const username = new StorageItem<string>('username')
+// Or
+const username = new StorageItem('username', {defaultValue: 'admin'})
 
 await username.set('Ugo');
 // Promise<void>