mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Tim Yung
2933b887cd
Summary: Renames `EventSubscription.js`, `EmitterSubscription.js`, and `EventSubscriptionVendor.js` to `_EventSubscription.js`, `_EmitterSubscription.js`, and `_EventSubscriptionVendor.js`, respectively. This is to indicate that those files are implementation details and should not be directly referenced. Instead, the `EventSubscription` type exported from `EventEmitter.js` should be used. The remaining stragglers that are importing `_EmitterSubscription.js` and `_EventSubscriptionVendor.js` after this commit will be cleaned up when `RCTDeviceEventEmitter` is refactored. Changelog: [Internal] (Note: this ignores all push blocking failures!) Reviewed By: cpojer Differential Revision: D22182310 fbshipit-source-id: 82be685f231395bd7b8e9986141b5df1367bec71
59 lines
1.6 KiB
JavaScript
59 lines
1.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 type EventEmitter from './EventEmitter';
|
|
import EventSubscription from './_EventSubscription';
|
|
import type EventSubscriptionVendor from './_EventSubscriptionVendor';
|
|
|
|
/**
|
|
* EmitterSubscription represents a subscription with listener and context data.
|
|
*/
|
|
class EmitterSubscription extends EventSubscription {
|
|
emitter: EventEmitter;
|
|
listener: Function;
|
|
context: ?Object;
|
|
|
|
/**
|
|
* @param {EventEmitter} emitter - The event emitter that registered this
|
|
* subscription
|
|
* @param {EventSubscriptionVendor} subscriber - The subscriber that controls
|
|
* this subscription
|
|
* @param {function} listener - Function to invoke when the specified event is
|
|
* emitted
|
|
* @param {*} context - Optional context object to use when invoking the
|
|
* listener
|
|
*/
|
|
constructor(
|
|
emitter: EventEmitter,
|
|
subscriber: EventSubscriptionVendor,
|
|
listener: Function,
|
|
context: ?Object,
|
|
) {
|
|
super(subscriber);
|
|
this.emitter = emitter;
|
|
this.listener = listener;
|
|
this.context = context;
|
|
}
|
|
|
|
/**
|
|
* Removes this subscription from the emitter that registered it.
|
|
* Note: we're overriding the `remove()` method of EventSubscription here
|
|
* but deliberately not calling `super.remove()` as the responsibility
|
|
* for removing the subscription lies with the EventEmitter.
|
|
*/
|
|
remove() {
|
|
this.emitter.removeSubscription(this);
|
|
}
|
|
}
|
|
|
|
module.exports = EmitterSubscription;
|