mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick Gerleman
8cdc9e7f04
Summary: React Native's TS definitions are currently mostly stored in one monolithic file. This change splits the definitions up to correspond to the source files they came from, and are placed next to the source files. I think this should help inform, and make it easy to update the TS declarations when touching the Flow file. I noticed as part of the change that the typings have not yet removed many APIs that were removed from RN. This is bad, since it means using the removed/non-functional API doesn't cause typechecker errors. Locating typings next to source should prevent that from being able to happen. The organization here means individual TS declarations can declare what will be in the RN entrypoint, which is a little confusing. Seems like a good potential next refactor, beyond the literal translation I did. Changelog: [General][Changed] - Place TS Declarations Alongside Source Files Reviewed By: lunaleaps, rshest Differential Revision: D39796598 fbshipit-source-id: b36366466fd1976bdd2d4c8f7a4104a33c457a07
71 lines
2.0 KiB
TypeScript
71 lines
2.0 KiB
TypeScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
import {
|
|
EmitterSubscription,
|
|
EventEmitter,
|
|
} from '../vendor/emitter/EventEmitter';
|
|
|
|
/**
|
|
* The React Native implementation of the IOS RCTEventEmitter which is required when creating
|
|
* a module that communicates with IOS
|
|
*/
|
|
type NativeModule = {
|
|
/**
|
|
* Add the provided eventType as an active listener
|
|
* @param eventType name of the event for which we are registering listener
|
|
*/
|
|
addListener: (eventType: string) => void;
|
|
|
|
/**
|
|
* Remove a specified number of events. There are no eventTypes in this case, as
|
|
* the native side doesn't remove the name, but only manages a counter of total
|
|
* listeners
|
|
* @param count number of listeners to remove (of any type)
|
|
*/
|
|
removeListeners: (count: number) => void;
|
|
};
|
|
|
|
/**
|
|
* Abstract base class for implementing event-emitting modules. This implements
|
|
* a subset of the standard EventEmitter node module API.
|
|
*/
|
|
declare class NativeEventEmitter extends EventEmitter {
|
|
/**
|
|
* @param nativeModule the NativeModule implementation. This is required on IOS and will throw
|
|
* an invariant error if undefined.
|
|
*/
|
|
constructor(nativeModule?: NativeModule);
|
|
|
|
/**
|
|
* Add the specified listener, this call passes through to the NativeModule
|
|
* addListener
|
|
*
|
|
* @param eventType name of the event for which we are registering listener
|
|
* @param listener the listener function
|
|
* @param context context of the listener
|
|
*/
|
|
addListener(
|
|
eventType: string,
|
|
listener: (event: any) => void,
|
|
context?: Object,
|
|
): EmitterSubscription;
|
|
|
|
/**
|
|
* @param eventType name of the event whose registered listeners to remove
|
|
*/
|
|
removeAllListeners(eventType: string): void;
|
|
|
|
/**
|
|
* Removes a subscription created by the addListener, the EventSubscription#remove()
|
|
* function actually calls through to this.
|
|
*/
|
|
removeSubscription(subscription: EmitterSubscription): void;
|
|
}
|