From bc2f9ad271d9591e4b0368ef89f32225f4a8cb46 Mon Sep 17 00:00:00 2001
From: Dawit Ameneshewa <dawitam11@gmail.com>
Date: Wed, 7 Dec 2022 09:44:15 +0300
Subject: [PATCH] Add documentation for an optional `handleStorageChange`
 method in `StorageApi`

Signed-off-by: Dawit Ameneshewa <dawitam11@gmail.com>
---
 packages/core-app-api/api-report.md                         | 2 ++
 packages/core-plugin-api/api-report.md                      | 1 +
 packages/core-plugin-api/src/apis/definitions/StorageApi.ts | 2 +-
 3 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.md
index 70312a54a5..54aa700472 100644
--- a/packages/core-app-api/api-report.md
+++ b/packages/core-app-api/api-report.md
@@ -558,6 +558,8 @@ export class WebStorage implements StorageApi {
   // (undocumented)
   get<T>(key: string): T | undefined;
   // (undocumented)
+  handleStorageChange(eventKey: StorageEvent['key']): void;
+  // (undocumented)
   observe$<T extends JsonValue>(
     key: string,
   ): Observable<StorageValueSnapshot<T>>;
diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md
index cebf09e908..ed40792c6a 100644
--- a/packages/core-plugin-api/api-report.md
+++ b/packages/core-plugin-api/api-report.md
@@ -697,6 +697,7 @@ export type SignInPageProps = {
 // @public
 export interface StorageApi {
   forBucket(name: string): StorageApi;
+  handleStorageChange?(eventKey: StorageEvent['key']): void;
   observe$<T extends JsonValue>(
     key: string,
   ): Observable<StorageValueSnapshot<T>>;
diff --git a/packages/core-plugin-api/src/apis/definitions/StorageApi.ts b/packages/core-plugin-api/src/apis/definitions/StorageApi.ts
index f8c0948ec6..5ecf251e2d 100644
--- a/packages/core-plugin-api/src/apis/definitions/StorageApi.ts
+++ b/packages/core-plugin-api/src/apis/definitions/StorageApi.ts
@@ -91,7 +91,7 @@ export interface StorageApi {
    *
    * @param eventKey - The key of a storage event object
    */
-  handleStorageChange(eventKey: StorageEvent['key']): void;
+  handleStorageChange?(eventKey: StorageEvent['key']): void;
 
   /**
    * Returns an immediate snapshot value for the given key, if possible.