add CustomStorageEvent

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

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/src/porridge.ts b/src/porridge.ts
@@ -30,7 +30,7 @@ const validStores = [
  */
 export class Porridge {
 	eventName: string;
-	storageArea: string;
+	storageArea: 'localStorage' | 'sessionStorage';
 
 	constructor(storageArea: 'localStorage' | 'sessionStorage' = 'localStorage', eventName = 'porridge.didChange') {
 		if (typeof eventName !== 'string') {

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, payload) {
+function eventDispatcher(eventName: string, payload: WebPorridge.CustomStorageEvent) {
 	try {
 		window.dispatchEvent(
 			new CustomEvent(eventName, {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -20,6 +20,13 @@ declare namespace WebPorridge {
 		value: '@value';
 		type: '@type';
 	}
+
+	type CustomStorageEvent = {
+		key?: string;
+		newValue: unknown;
+		oldValue: unknown;
+		storageArea: 'localStorage' | 'sessionStorage' | 'indexedDB';
+	}
 }
 
 export {