added events().onNavigationEvent(..)

docs/api/EventsRegistry.md

@@ -40,4 +40,12 @@
 
 ---
 
+## onNavigationEvent
+
+`onNavigationEvent(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L28)
+
+---
+
 

docs/api/NativeEventsReceiver.md

@@ -32,4 +32,12 @@
 
 ---
 
+## registerOnNavigationEvent
+
+`registerOnNavigationEvent(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L26)
+
+---
+
 

lib/src/adapters/NativeEventsReceiver.ts

@@ -22,4 +22,8 @@ export class NativeEventsReceiver {
   registerOnNavigationButtonPressed(callback: (params) => void): EventSubscription {
     return this.emitter.addListener('RNN.onNavigationButtonPressed', callback);
   }
+
+  public registerOnNavigationEvent(callback: (params) => void): EventSubscription {
+    return this.emitter.addListener('RNN.onNavigationEvent', callback);
+  }
 }

lib/src/events/EventsRegistry.test.ts

@@ -82,4 +82,26 @@ describe('EventsRegistry', () => {
     commandsObserver.notify('theCommandName', { x: 1 });
     expect(cb).not.toHaveBeenCalled();
   });
+
+  it('onNavigationEvent', () => {
+    const subscription = {};
+    const cb = jest.fn();
+    mockNativeEventsReceiver.registerOnNavigationEvent.mockReturnValueOnce(subscription);
+
+    const result = uut.onNavigationEvent(cb);
+
+    expect(result).toBe(subscription);
+    expect(mockNativeEventsReceiver.registerOnNavigationEvent).toHaveBeenCalledTimes(1);
+
+    mockNativeEventsReceiver.registerOnNavigationEvent.mock.calls[0][0]({ name: 'the event name', params: { a: 1 } });
+    expect(cb).toHaveBeenCalledWith('the event name', { a: 1 });
+  });
+
+  it('onNavigationEvent unregister', () => {
+    const subscription = {};
+    const cb = jest.fn();
+    mockNativeEventsReceiver.registerOnNavigationEvent.mockReturnValueOnce(subscription);
+    const result = uut.onNavigationEvent(cb);
+    expect(result).toBe(subscription);
+  });
 });

lib/src/events/EventsRegistry.ts

@@ -24,4 +24,8 @@ export class EventsRegistry {
   public onNavigationCommand(callback: (name: string, params: any) => void): EventSubscription {
     return this.commandsObserver.register(callback);
   }
+
+  public onNavigationEvent(callback: (name: string, params: any) => void): EventSubscription {
+    return this.nativeEventsReceiver.registerOnNavigationEvent(({ name, params }) => callback(name, params));
+  }
 }