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
59 lines
2.0 KiB
TypeScript
59 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 {NativeEventSubscription} from '../EventEmitter/RCTNativeAppEventEmitter';
|
|
|
|
/**
|
|
* AppState can tell you if the app is in the foreground or background,
|
|
* and notify you when the state changes.
|
|
*
|
|
* AppState is frequently used to determine the intent and proper behavior
|
|
* when handling push notifications.
|
|
*
|
|
* App State Events
|
|
* change - This even is received when the app state has changed.
|
|
* focus [Android] - Received when the app gains focus (the user is interacting with the app).
|
|
* blur [Android] - Received when the user is not actively interacting with the app.
|
|
*
|
|
* App States
|
|
* active - The app is running in the foreground
|
|
* background - The app is running in the background. The user is either in another app or on the home screen
|
|
* inactive [iOS] - This is a transition state that currently never happens for typical React Native apps.
|
|
* unknown [iOS] - Initial value until the current app state is determined
|
|
* extension [iOS] - The app is running as an app extension
|
|
*
|
|
* For more information, see Apple's documentation: https://developer.apple.com/library/ios/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html
|
|
*
|
|
* @see https://reactnative.dev/docs/appstate#app-states
|
|
*/
|
|
export type AppStateEvent = 'change' | 'memoryWarning' | 'blur' | 'focus';
|
|
export type AppStateStatus =
|
|
| 'active'
|
|
| 'background'
|
|
| 'inactive'
|
|
| 'unknown'
|
|
| 'extension';
|
|
|
|
export interface AppStateStatic {
|
|
currentState: AppStateStatus;
|
|
isAvailable: boolean;
|
|
|
|
/**
|
|
* Add a handler to AppState changes by listening to the change event
|
|
* type and providing the handler
|
|
*/
|
|
addEventListener(
|
|
type: AppStateEvent,
|
|
listener: (state: AppStateStatus) => void,
|
|
): NativeEventSubscription;
|
|
}
|
|
|
|
export const AppState: AppStateStatic;
|
|
export type AppState = AppStateStatic;
|