Files
react-native/Libraries/EventEmitter/NativeEventEmitter.d.ts
T
Helena Ford 4acef8e4a4 fix: EventEmitter ts definition file (#36462)
Summary:
There's an error in the `d.ts` file for EventEmitter which causes the following error:

```
This expression is not constructable.
  Type 'typeof import(".../vendor/emitter/EventEmitter")' has no construct signatures.
const emitter = new EventEmitter();
                      ~~~~~~~~~~~~
```

See https://github.com/facebook/react-native/blob/dce9d8d5de381fe53760ddda0d6cbbdfb5be00e4/Libraries/vendor/emitter/EventEmitter.js#L63

## Changelog

<!-- Help reviewers and the release process by writing your own changelog entry.

Pick one each for the category and type tags:

[GENERAL] [FIXED] -Fixes an issue with the EventEmitter type definition file

For more details, see:
https://reactnative.dev/contributing/changelogs-in-pull-requests
-->

Pull Request resolved: https://github.com/facebook/react-native/pull/36462

Reviewed By: cipolleschi

Differential Revision: D44130846

Pulled By: javache

fbshipit-source-id: 64cecdf55e58b99b243392811226e5095d5dc006
2023-03-16 06:04:51 -07:00

70 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 EventEmitter, {
EmitterSubscription,
} 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;
}