webext-storage 1.2.1 → 1.2.2

package/distribution/storage-item.d.ts

@@ -7,9 +7,11 @@ export declare class StorageItem<Base, Default = Base | undefined, Return = Defa
     readonly key: string;
     readonly area: chrome.storage.AreaName;
     readonly defaultValue?: Default;
+    /** @deprecated Use `onChanged` instead */
+    onChange: (callback: (value: NonNullable<Default>) => void, signal?: AbortSignal) => void;
     constructor(key: string, { area, defaultValue, }?: StorageItemOptions<NonNullable<Default>>);
     get: () => Promise<Return>;
     set: (value: NonNullable<Default>) => Promise<void>;
     remove: () => Promise<void>;
-    onChange(callback: (value: NonNullable<Default>) => void, signal?: AbortSignal): void;
+    onChanged(callback: (value: NonNullable<Default>) => void, signal?: AbortSignal): void;
 }

package/distribution/storage-item.js

@@ -3,6 +3,8 @@ export class StorageItem {
     key;
     area;
     defaultValue;
+    /** @deprecated Use `onChanged` instead */
+    onChange = this.onChanged;
     constructor(key, { area = 'local', defaultValue, } = {}) {
         this.key = key;
         this.area = area;
@@ -22,7 +24,7 @@ export class StorageItem {
     remove = async () => {
         await chromeP.storage[this.area].remove(this.key);
     };
-    onChange(callback, signal) {
+    onChanged(callback, signal) {
         const changeHandler = (changes, area) => {
             const changedItem = changes[this.key];
             if (area === this.area && changedItem) {

package/package.json

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

package/readme.md

@@ -29,7 +29,7 @@ chrome.storage.onChanged.addListener((storageArea, change) => {
 const options = new StorageItem<Record<string, string>>('user-options');
 const value = await options.get(); // The type is `Record<string, string> | undefined`
 await options.set({color: 'red'}) // Type-checked
-options.onChange(newValue => {
+options.onChanged(newValue => {
 	console.log('New options', newValue)
 });
 ```
@@ -40,7 +40,7 @@ Why this is better:
 - `get` only is only `.get()` instead of the awkward post-get object access that
 - Every `get` and `set` operation is type-safe
 - If you provide a `defaultValue`, the return type will not be ` | undefined`
-- The `onChange` example speaks for itself
+- The `onChanged` example speaks for itself
 
 ## Install
 
@@ -71,7 +71,7 @@ await username.remove();
 await username.set({name: 'Ugo'});
 // TypeScript Error: Argument of type '{ name: string; }' is not assignable to parameter of type 'string'.
 
-username.onChange(newName => {
+username.onChanged(newName => {
 	console.log('The user’s new name is', newName);
 });
 ```