Skip to content

Clarify documentation for turbomodules #3787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javache merged 3 commits into from
Jul 7, 2023
+1 −1
Merged

Clarify documentation for turbomodules #3787

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7773dc1
Clarify documentation for turbomodules
StefanWallin Jul 7, 2023
be8e2e9
Fix linting issue
StefanWallin Jul 7, 2023
3226584
Update the PR to reflect knowledge that the code sample is correct bu…
StefanWallin Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/the-new-architecture/pillars-turbomodule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The upper part of the file contains some descriptive information like the name o

Then there are the dependencies for this package. For this guide, you need `react` and `react-native`.

Finally, the **Codegen** configuration is specified by the `codegenConfig` field. It contains an array of libraries, each of which is defined by three other fields:
Finally, the **Codegen** configuration is specified by the `codegenConfig` field. It contains an object that defines the module through four fields:

- `name`: The name of the library. By convention, you should add the `Spec` suffix.
- `type`: The type of module contained by this package. In this case, it is a Turbo Native Module; thus, the value to use is `modules`.
Expand Down