mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick GerlemanandFacebook GitHub Bot
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
77 lines
2.3 KiB
TypeScript
77 lines
2.3 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
|
|
*/
|
|
|
|
export interface RelayProfiler {
|
|
attachProfileHandler(
|
|
name: string,
|
|
handler: (name: string, state?: any) => () => void,
|
|
): void;
|
|
|
|
attachAggregateHandler(
|
|
name: string,
|
|
handler: (name: string, callback: () => void) => void,
|
|
): void;
|
|
}
|
|
|
|
export interface SystraceStatic {
|
|
setEnabled(enabled: boolean): void;
|
|
|
|
/**
|
|
* beginEvent/endEvent for starting and then ending a profile within the same call stack frame
|
|
**/
|
|
beginEvent(profileName?: any, args?: any): void;
|
|
endEvent(): void;
|
|
|
|
/**
|
|
* beginAsyncEvent/endAsyncEvent for starting and then ending a profile where the end can either
|
|
* occur on another thread or out of the current stack frame, eg await
|
|
* the returned cookie variable should be used as input into the endAsyncEvent call to end the profile
|
|
**/
|
|
beginAsyncEvent(profileName?: any): any;
|
|
endAsyncEvent(profileName?: any, cookie?: any): void;
|
|
|
|
/**
|
|
* counterEvent registers the value to the profileName on the systrace timeline
|
|
**/
|
|
counterEvent(profileName?: any, value?: any): void;
|
|
|
|
/**
|
|
* Relay profiles use await calls, so likely occur out of current stack frame
|
|
* therefore async variant of profiling is used
|
|
**/
|
|
attachToRelayProfiler(relayProfiler: RelayProfiler): void;
|
|
|
|
/* This is not called by default due to perf overhead but it's useful
|
|
if you want to find traces which spend too much time in JSON. */
|
|
swizzleJSON(): void;
|
|
|
|
/**
|
|
* Measures multiple methods of a class. For example, you can do:
|
|
* Systrace.measureMethods(JSON, 'JSON', ['parse', 'stringify']);
|
|
*
|
|
* @param methodNames Map from method names to method display names.
|
|
*/
|
|
measureMethods(
|
|
object: any,
|
|
objectName: string,
|
|
methodNames: Array<string>,
|
|
): void;
|
|
|
|
/**
|
|
* Returns an profiled version of the input function. For example, you can:
|
|
* JSON.parse = Systrace.measure('JSON', 'parse', JSON.parse);
|
|
*
|
|
* @return replacement function
|
|
*/
|
|
measure<T extends Function>(objName: string, fnName: string, func: T): T;
|
|
}
|
|
|
|
export const Systrace: SystraceStatic;
|
|
export type Systrace = SystraceStatic;
|