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
69 lines
2.0 KiB
TypeScript
69 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 type * as React from 'react';
|
|
|
|
type Task = (taskData: any) => Promise<void>;
|
|
type TaskProvider = () => Task;
|
|
|
|
export type ComponentProvider = () => React.ComponentType<any>;
|
|
|
|
export type Runnable = (appParameters: any) => void;
|
|
|
|
export type AppConfig = {
|
|
appKey: string;
|
|
component?: ComponentProvider | undefined;
|
|
run?: Runnable | undefined;
|
|
};
|
|
|
|
/**
|
|
* `AppRegistry` is the JS entry point to running all React Native apps. App
|
|
* root components should register themselves with
|
|
* `AppRegistry.registerComponent`, then the native system can load the bundle
|
|
* for the app and then actually run the app when it's ready by invoking
|
|
* `AppRegistry.runApplication`.
|
|
*
|
|
* To "stop" an application when a view should be destroyed, call
|
|
* `AppRegistry.unmountApplicationComponentAtRootTag` with the tag that was
|
|
* pass into `runApplication`. These should always be used as a pair.
|
|
*
|
|
* `AppRegistry` should be `require`d early in the `require` sequence to make
|
|
* sure the JS execution environment is setup before other modules are
|
|
* `require`d.
|
|
*/
|
|
export namespace AppRegistry {
|
|
export function registerConfig(config: AppConfig[]): void;
|
|
|
|
export function registerComponent(
|
|
appKey: string,
|
|
getComponentFunc: ComponentProvider,
|
|
): string;
|
|
|
|
export function registerRunnable(appKey: string, func: Runnable): string;
|
|
|
|
export function getAppKeys(): string[];
|
|
|
|
export function unmountApplicationComponentAtRootTag(rootTag: number): void;
|
|
|
|
export function runApplication(appKey: string, appParameters: any): void;
|
|
|
|
export function setSurfaceProps(
|
|
appKey: string,
|
|
appParameters: any,
|
|
displayMode?: number,
|
|
): void;
|
|
|
|
export function registerHeadlessTask(
|
|
appKey: string,
|
|
task: TaskProvider,
|
|
): void;
|
|
|
|
export function getRunnable(appKey: string): Runnable | undefined;
|
|
}
|