Files
react-native/Libraries/EventEmitter/RCTDeviceEventEmitter.js
T
Rubén Norte fa406ac2aa Implement typed event emitters
Summary:
Adds types to Event Emitters and migrates the most relevant modules using them in `react-native`.

The most relevant file of this diff is `react-native/Libraries/vendor/emitter/__flowtests__/EventEmitter-flowtest.js` with the Flow tests showing and testing the behavior of the new types

Changelog: [Internal] Add types for Event Emitters and subclasses

Reviewed By: motiz88

Differential Revision: D25587936

fbshipit-source-id: feeb09f9ad15d383cdd82deaaaba0d12b94e868b
2021-01-07 03:19:04 -08:00

91 lines
2.6 KiB
JavaScript

/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow
*/
'use strict';
import EventEmitter from '../vendor/emitter/EventEmitter';
import type EmitterSubscription from '../vendor/emitter/_EmitterSubscription';
import EventSubscriptionVendor from '../vendor/emitter/_EventSubscriptionVendor';
function checkNativeEventModule(eventType: ?string) {
if (eventType) {
if (eventType.lastIndexOf('statusBar', 0) === 0) {
throw new Error(
'`' +
eventType +
'` event should be registered via the StatusBarIOS module',
);
}
if (eventType.lastIndexOf('keyboard', 0) === 0) {
throw new Error(
'`' +
eventType +
'` event should be registered via the Keyboard module',
);
}
if (eventType === 'appStateDidChange' || eventType === 'memoryWarning') {
throw new Error(
'`' +
eventType +
'` event should be registered via the AppState module',
);
}
}
}
/**
* Deprecated - subclass NativeEventEmitter to create granular event modules instead of
* adding all event listeners directly to RCTDeviceEventEmitter.
*/
class RCTDeviceEventEmitter<
EventDefinitions: {...},
> extends EventEmitter<EventDefinitions> {
sharedSubscriber: EventSubscriptionVendor<EventDefinitions>;
constructor() {
const sharedSubscriber = new EventSubscriptionVendor<EventDefinitions>();
super(sharedSubscriber);
this.sharedSubscriber = sharedSubscriber;
}
addListener<K: $Keys<EventDefinitions>>(
eventType: K,
listener: (...$ElementType<EventDefinitions, K>) => mixed,
context: $FlowFixMe,
): EmitterSubscription<EventDefinitions, K> {
if (__DEV__) {
checkNativeEventModule(eventType);
}
return super.addListener(eventType, listener, context);
}
removeAllListeners<K: $Keys<EventDefinitions>>(eventType: ?K): void {
if (__DEV__) {
checkNativeEventModule(eventType);
}
super.removeAllListeners(eventType);
}
removeSubscription<K: $Keys<EventDefinitions>>(
subscription: EmitterSubscription<EventDefinitions, K>,
): void {
if (subscription.emitter !== this) {
subscription.emitter.removeSubscription(subscription);
} else {
super.removeSubscription(subscription);
}
}
}
// FIXME: use typed events
type RCTDeviceEventDefinitions = $FlowFixMe;
export default (new RCTDeviceEventEmitter(): RCTDeviceEventEmitter<RCTDeviceEventDefinitions>);