Files
react-native/Libraries/TurboModule/RCTExport.js
T
Tim Yung 5242ad931b RN: Add RootTag Type to TurboModule
Summary:
Adds `RootTag` as a valid type for arguments and return types in TurboModules (on both Android and iOS).

This will enable us to change `RootTag` into an opaque type. There are two compelling reasons to do this:

- JavaScript will no longer be able to safely depend on `RootTag` being a number (which means we can change this in the future).
- Call sites using `unstable_RootTagContext` will can get a `RootTag`, but call sites using the legacy `context.rootTag` will not. This means the opaque type will give us a strategy for migrating away from legacy context and eventually making `unstable_RootTagContext` the only way to access `RootTag`.

Changelog:
[Internal]

(Note: this ignores all push blocking failures!)

Reviewed By: RSNara

Differential Revision: D21127170

fbshipit-source-id: baec9d7ad17b2f8c4527f1a84f604fc0d28b97eb
2020-04-21 19:15:54 -07:00

39 lines
1.2 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.
*
* @flow strict
* @format
*/
'use strict';
/**
* NOTE: This is React Native specific export type.
*
* DEPRECATED_RCTExport is an interface type that allows native code generation
* for React Native native modules. It exists as a hint to the codegen tool that
* any interface that extends it needs to be codegen'ed. Example usage:
*
* export interface RCTFoobar extends DEPRECATED_RCTExport<void> {}
*
* Native definition for RCTFoobar will then be generated.
*
* The type param T is a placeholder for future codegen hinting, like versioning
* information, native base classes, etc. For now, simply use `void` type as
* there's nothing to give hint about.
*
* NOTE: This export is deprecated. Please use TurboModule.
*/
// eslint-disable-next-line no-unused-vars
export interface DEPRECATED_RCTExport<T: void = void> {
+getConstants?: () => {...};
}
export interface TurboModule extends DEPRECATED_RCTExport<void> {}
export type {RootTag} from '../ReactNative/RootTag.js';