fix addListener signature

hugotomazi · Jun 22, 2024 · 0800c59 · 0800c59
1 parent e108809
commit 0800c59
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -132,7 +132,7 @@ Gets the current color of the navigation bar in Hexadecimal.
 ### addListener(...)
 
 ```typescript
-addListener(event: NavigationBarPluginEvents.SHOW, listenerFunc: () => void) => PluginListenerHandle
+addListener(event: NavigationBarPluginEvents.SHOW, listenerFunc: () => void) => Promise<PluginListenerHandle>
 ```
 
 Event fired after navigation bar is displayed
@@ -142,15 +142,15 @@ Event fired after navigation bar is displayed
 | **`event`**        | <code><a href="#navigationbarpluginevents">NavigationBarPluginEvents.SHOW</a></code> | The event   |
 | **`listenerFunc`** | <code>() =&gt; void</code>                                                           | Callback    |
 
-**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
 --------------------
 
 
 ### addListener(...)
 
 ```typescript
-addListener(event: NavigationBarPluginEvents.HIDE, listenerFunc: () => void) => PluginListenerHandle
+addListener(event: NavigationBarPluginEvents.HIDE, listenerFunc: () => void) => Promise<PluginListenerHandle>
 ```
 
 Event fired after navigation bar is hidden
@@ -160,15 +160,15 @@ Event fired after navigation bar is hidden
 | **`event`**        | <code><a href="#navigationbarpluginevents">NavigationBarPluginEvents.HIDE</a></code> | The event   |
 | **`listenerFunc`** | <code>() =&gt; void</code>                                                           | Callback    |
 
-**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
 --------------------
 
 
 ### addListener(...)
 
 ```typescript
-addListener(event: NavigationBarPluginEvents.COLOR_CHANGE, listenerFunc: (returnObject: { color: string; }) => void) => PluginListenerHandle
+addListener(event: NavigationBarPluginEvents.COLOR_CHANGE, listenerFunc: (returnObject: { color: string; }) => void) => Promise<PluginListenerHandle>
 ```
 
 Event fired after navigation bar color is changed
@@ -178,7 +178,7 @@ Event fired after navigation bar color is changed
 | **`event`**        | <code><a href="#navigationbarpluginevents">NavigationBarPluginEvents.COLOR_CHANGE</a></code> | The event   |
 | **`listenerFunc`** | <code>(returnObject: { color: string; }) =&gt; void</code>                                   | Callback    |
 
-**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
 --------------------
 

diff --git a/src/definitions.ts b/src/definitions.ts
@@ -38,7 +38,7 @@ export interface NavigationBarPlugin {
   addListener(
     event: NavigationBarPluginEvents.SHOW,
     listenerFunc: () => void
-  ): PluginListenerHandle
+  ): Promise<PluginListenerHandle>
 
   /**
    * Event fired after navigation bar is hidden
@@ -48,7 +48,7 @@ export interface NavigationBarPlugin {
   addListener(
     event: NavigationBarPluginEvents.HIDE, 
     listenerFunc: () => void
-  ): PluginListenerHandle
+  ): Promise<PluginListenerHandle>
 
   /**
    * Event fired after navigation bar color is changed
@@ -58,7 +58,7 @@ export interface NavigationBarPlugin {
   addListener(
     event: NavigationBarPluginEvents.COLOR_CHANGE,
     listenerFunc: (returnObject: { color: string }) => void
-  ): PluginListenerHandle
+  ): Promise<PluginListenerHandle>
 }
 
 export interface ColorParameters {