附录
一、术语
-
Spec - TypeScript 或 Flow 形式的代码,用于描述 Turbo Native 模块或 Fabric 原生组件的 API。Codegen 根据它来生成样板代码。
-
原生模块(Native Modules) - 没有用户界面(UI)的原生库。例如持久化存储、通知、网络事件等。在 JavaScript 应用代码中以函数和对象的形式使用。
-
原生组件(Native Component) - 原生平台视图,可以通过 React 组件的方式在 JavaScript 应用代码中使用。
-
传统原生组件(Legacy Native Components) - 运行在 React Native 旧架构上的组件。
-
传统原生模块(Legacy Native Modules) - 运行在 React Native 旧架构上的模块。
二、Codegen 类型
你可以使用以下表格作为参考,了解每种类型的支持情况及其在各平台上的映射关系:
| Flow | TypeScript | Flow Nullable Support | TypeScript Nullable Support | Android (Java) | iOS (ObjC) |
|---|---|---|---|---|---|
string | string | ?string | string | null | string | NSString |
boolean | boolean | ?boolean | boolean | null | Boolean | NSNumber |
Object Literal{| foo: string, ...|} | { foo: string, ...} as const | ?{| foo: string, ...|} | ?{ foo: string, ...} as const | - | - |
| Object [1] | Object [1] | ?Object | Object | null | ReadableMap | @ (untyped dictionary) |
Array<T> | Array<T> | ?Array<T> | Array<T> | null | ReadableArray | NSArray (or RCTConvertVecToArray when used inside objects) |
Function | Function | ?Function | Function | null | - | - |
Promise<T> | Promise<T> | ?Promise<T> | Promise<T> | null | com.facebook.react.bridge.Promise | RCTPromiseResolve and RCTPromiseRejectBlock |
Type Unions'SUCCESS'|'FAIL' | Type Unions'SUCCESS'|'FAIL' | Only as callbacks | - | - | |
Callbacks() => | Callbacks() => | Yes | com.facebook.react.bridge.Callback | RCTResponseSenderBlock | |
number | number | No | double | NSNumber |
Notes:
[1] 我们强烈建议使用对象字面量(Object Literal)而不是 Object。
info
你也可以参考 React Native 核心模块的 JavaScript 规范,这些文件位于 React Native 仓库的 Libraries/ 目录中。