Files
react-native/Libraries/EventEmitter/NativeEventEmitter.js
T
Rubén Norte c7463f0059 Add FlowFixMes for future violations of typed NativeEventEmitter
Summary:
Migrates all usages of `NativeEventEmitter` to `NativeEventEmitter<$FlowFixMe>`.

This prevents having to modify a very large number of files in the same change that adds support for typed events. It adds an unused typed parameter to `NativeEventEmitter` so we can change all usages to add `$FlowFixMe`.

Changelog: [Internal]

Reviewed By: nadiia

Differential Revision: D25575774

fbshipit-source-id: c7979e1502e980401d9c03456282eba333c1606d
2021-01-04 03:56:57 -08:00

83 lines
2.4 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 Platform from '../Utilities/Platform';
import EventEmitter from '../vendor/emitter/EventEmitter';
import {type EventSubscription} from '../vendor/emitter/EventEmitter';
import RCTDeviceEventEmitter from './RCTDeviceEventEmitter';
import invariant from 'invariant';
type NativeModule = {
+addListener: (eventType: string) => void,
+removeListeners: (count: number) => void,
...
};
type NativeEventEmitterOptions = $ReadOnly<{|
__SECRET_DISABLE_CALLS_INTO_MODULE_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: boolean,
|}>;
const DEFAULT_NATIVE_EVENT_EMITTER_OPTIONS = {
__SECRET_DISABLE_CALLS_INTO_MODULE_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: false,
};
/**
* Abstract base class for implementing event-emitting modules. This implements
* a subset of the standard EventEmitter node module API.
*/
export default class NativeEventEmitter<
_GenericArgumentPlaceholder,
> extends EventEmitter {
_nativeModule: ?NativeModule;
_disableCallsIntoModule: boolean;
constructor(
nativeModule: ?NativeModule,
options: NativeEventEmitterOptions = DEFAULT_NATIVE_EVENT_EMITTER_OPTIONS,
) {
super(RCTDeviceEventEmitter.sharedSubscriber);
this._disableCallsIntoModule =
options.__SECRET_DISABLE_CALLS_INTO_MODULE_DO_NOT_USE_OR_YOU_WILL_BE_FIRED;
if (Platform.OS === 'ios') {
invariant(nativeModule, 'Native module cannot be null.');
this._nativeModule = nativeModule;
}
}
addListener(
eventType: string,
listener: Function,
context: ?Object,
): EventSubscription {
if (this._nativeModule != null && !this._disableCallsIntoModule) {
this._nativeModule.addListener(eventType);
}
return super.addListener(eventType, listener, context);
}
removeAllListeners(eventType: string) {
invariant(eventType, 'eventType argument is required.');
const count = this.listenerCount(eventType);
if (this._nativeModule != null && !this._disableCallsIntoModule) {
this._nativeModule.removeListeners(count);
}
super.removeAllListeners(eventType);
}
removeSubscription(subscription: EventSubscription) {
if (this._nativeModule != null && !this._disableCallsIntoModule) {
this._nativeModule.removeListeners(1);
}
super.removeSubscription(subscription);
}
}