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
75 lines
2.0 KiB
TypeScript
75 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} from '../vendor/emitter/EventEmitter';
|
|
|
|
export type Handle = number;
|
|
|
|
export type SimpleTask = {
|
|
name: string;
|
|
gen: () => void;
|
|
};
|
|
export type PromiseTask = {
|
|
name: string;
|
|
gen: () => Promise<any>;
|
|
};
|
|
|
|
export interface InteractionManagerStatic {
|
|
Events: {
|
|
interactionStart: string;
|
|
interactionComplete: string;
|
|
};
|
|
|
|
/**
|
|
* Adds a listener to be invoked when events of the specified type are
|
|
* emitted. An optional calling context may be provided. The data arguments
|
|
* emitted will be passed to the listener function.
|
|
*
|
|
* @param eventType - Name of the event to listen to
|
|
* @param listener - Function to invoke when the specified event is
|
|
* emitted
|
|
* @param context - Optional context object to use when invoking the
|
|
* listener
|
|
*/
|
|
addListener(
|
|
eventType: string,
|
|
listener: (...args: any[]) => any,
|
|
context?: any,
|
|
): EmitterSubscription;
|
|
|
|
/**
|
|
* Schedule a function to run after all interactions have completed.
|
|
* Returns a cancellable
|
|
*/
|
|
runAfterInteractions(task?: (() => any) | SimpleTask | PromiseTask): {
|
|
then: (onfulfilled?: () => any, onrejected?: () => any) => Promise<any>;
|
|
done: (...args: any[]) => any;
|
|
cancel: () => void;
|
|
};
|
|
|
|
/**
|
|
* Notify manager that an interaction has started.
|
|
*/
|
|
createInteractionHandle(): Handle;
|
|
|
|
/**
|
|
* Notify manager that an interaction has completed.
|
|
*/
|
|
clearInteractionHandle(handle: Handle): void;
|
|
|
|
/**
|
|
* A positive number will use setTimeout to schedule any tasks after
|
|
* the eventLoopRunningTime hits the deadline value, otherwise all
|
|
* tasks will be executed in one setImmediate batch (default).
|
|
*/
|
|
setDeadline(deadline: number): void;
|
|
}
|
|
|
|
export const InteractionManager: InteractionManagerStatic;
|