add StorageEvent type

idleberg · Jun 15, 2024 · ed32e11 · ed32e11
1 parent 99da11f
commit ed32e11
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/src/porridge-db.ts b/src/porridge-db.ts
@@ -252,7 +252,7 @@ export class PorridgeDB {
 	}
 
 	/**
-	 * Observes value changes on a IndexedDB item
+	 * Returns an array of IndexedDB's own enumerable string-keyed property `[key, value]` pairs
 	 * @param {String} keyName
 	 * @returns {boolean}
 	 *
@@ -281,7 +281,7 @@ export class PorridgeDB {
 	 * });
 	 * ```
 	 */
-	public observe(keyName: string, callback: (payload: any) => void, targetOrigins: string[] = []): void {
+	public observe(keyName: string, callback: (payload: WebPorridge.StorageEvent) => void, targetOrigins: string[] = []): void {
 		if (typeof callback !== 'function') {
 			throw new TypeError('The callback argument is not a function');
 		}

diff --git a/src/porridge.ts b/src/porridge.ts
@@ -275,7 +275,7 @@ export class Porridge {
 	 * });
 	 * ```
 	 */
-	public observe(keyName: string, callback: (payload: any) => void, targetOrigins: string[] = []): void {
+	public observe(keyName: string, callback: (payload: WebPorridge.StorageEvent) => void, targetOrigins: string[] = []): void {
 		if (typeof callback !== 'function') {
 			throw new TypeError('The callback argument is not a function');
 		}

diff --git a/src/util.ts b/src/util.ts
@@ -102,7 +102,7 @@ function didExpire(expires: string): boolean {
 	return expires && new Date(expires) <= new Date();
 }
 
-function eventDispatcher(eventName: string, payload: WebPorridge.CustomStorageEvent) {
+function eventDispatcher(eventName: string, payload: WebPorridge.StorageEvent) {
 	try {
 		window.dispatchEvent(
 			new CustomEvent(eventName, {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -21,7 +21,7 @@ declare namespace WebPorridge {
 		type: '@type';
 	}
 
-	type CustomStorageEvent = {
+	type StorageEvent = {
 		key?: string;
 		newValue: unknown;
 		oldValue: unknown;