Skip to content

[DOC] Use CodegenTypes without deep import #4696

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
cipolleschi merged 4 commits into from
Aug 7, 2025
Merged

[DOC] Use CodegenTypes without deep import #4696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94cf6b4
fix CodegenTypes EventEmitter
migueldaipre Aug 7, 2025
8771794
fix versioned doc
migueldaipre Aug 7, 2025
359ccd2
fix next docs
migueldaipre Aug 7, 2025
af53a26
Update native-modules-custom-events.md
migueldaipre Aug 7, 2025
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
12 changes: 5 additions & 7 deletions docs/the-new-architecture/native-modules-custom-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ The first step would be to update the specs of the `NativeLocalStorage` specs to
Open the `NativeLocalStorage.ts` file and update it as it follows:

```diff title="NativeLocalStorage.ts"
import type {TurboModule} from 'react-native';
+import type {TurboModule, CodegenTypes} from 'react-native';
import {TurboModuleRegistry} from 'react-native';
+import type {EventEmitter} from 'react-native/Libraries/Types/CodegenTypes';

+export type KeyValuePair = {
+ key: string,
Expand All @@ -38,7 +37,7 @@ export interface Spec extends TurboModule {
removeItem(key: string): void;
clear(): void;

+ readonly onKeyAdded: EventEmitter<KeyValuePair>;
+ readonly onKeyAdded: CodegenTypes.EventEmitter<KeyValuePair>;
}

export default TurboModuleRegistry.getEnforcing<Spec>(
Expand All @@ -54,9 +53,8 @@ Open the `NativeLocalStorage.js` file and update it as it follows:
```diff title="NativeLocalStorage.js"

// @flow
import type {TurboModule} from 'react-native';
+import type {TurboModule, CodegenTypes} from 'react-native';
import {TurboModule, TurboModuleRegistry} from 'react-native';
+import type {EventEmitter} from 'react-native/Libraries/Types/CodegenTypes';

+export type KeyValuePair = {
+ key: string,
Expand All @@ -68,7 +66,7 @@ export interface Spec extends TurboModule {
getItem(key: string): ?string;
removeItem(key: string): void;
clear(): void;
+ onKeyAdded: EventEmitter<KeyValuePair>
+ onKeyAdded: CodegenTypes.EventEmitter<KeyValuePair>
}
export default (TurboModuleRegistry.get<Spec>(
'NativeLocalStorage'
Expand All @@ -78,7 +76,7 @@ export default (TurboModuleRegistry.get<Spec>(
</TabItem>
</Tabs>

With the `import type` statement, you are importing the `EventEmitter` type that is required to then add the `onKeyAdded` property.
With the `import type` statement, you are importing the `CodegenTypes` from `react-native`, which includes the `EventEmitter` type. This allows you to define the `onKeyAdded` property using `CodegenTypes.EventEmitter<KeyValuePair>`, specifying that the event will emit a payload of type `KeyValuePair`.

When the event is emitted, you expect for it to receive a parameter of type `string`.

Expand Down
12 changes: 5 additions & 7 deletions ...ersioned_docs/version-0.80/the-new-architecture/native-modules-custom-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ The first step would be to update the specs of the `NativeLocalStorage` specs to
Open the `NativeLocalStorage.ts` file and update it as it follows:

```diff title="NativeLocalStorage.ts"
import type {TurboModule} from 'react-native';
+import type {TurboModule, CodegenTypes} from 'react-native';
import {TurboModuleRegistry} from 'react-native';
+import type {EventEmitter} from 'react-native/Libraries/Types/CodegenTypes';

+export type KeyValuePair = {
+ key: string,
Expand All @@ -38,7 +37,7 @@ export interface Spec extends TurboModule {
removeItem(key: string): void;
clear(): void;

+ readonly onKeyAdded: EventEmitter<KeyValuePair>;
+ readonly onKeyAdded: CodegenTypes.EventEmitter<KeyValuePair>;
}

export default TurboModuleRegistry.getEnforcing<Spec>(
Expand All @@ -54,9 +53,8 @@ Open the `NativeLocalStorage.js` file and update it as it follows:
```diff title="NativeLocalStorage.js"

// @flow
import type {TurboModule} from 'react-native';
+import type {TurboModule, CodegenTypes} from 'react-native';
import {TurboModule, TurboModuleRegistry} from 'react-native';
+import type {EventEmitter} from 'react-native/Libraries/Types/CodegenTypes';

+export type KeyValuePair = {
+ key: string,
Expand All @@ -68,7 +66,7 @@ export interface Spec extends TurboModule {
getItem(key: string): ?string;
removeItem(key: string): void;
clear(): void;
+ onKeyAdded: EventEmitter<KeyValuePair>
+ onKeyAdded: CodegenTypes.EventEmitter<KeyValuePair>
}
export default (TurboModuleRegistry.get<Spec>(
'NativeLocalStorage'
Expand All @@ -78,7 +76,7 @@ export default (TurboModuleRegistry.get<Spec>(
</TabItem>
</Tabs>

With the `import type` statement, you are importing the `EventEmitter` type that is required to then add the `onKeyAdded` property.
With the `import type` statement, you are importing the `CodegenTypes` from `react-native`, which includes the `EventEmitter` type. This allows you to define the `onKeyAdded` property using `CodegenTypes.EventEmitter<KeyValuePair>`, specifying that the event will emit a payload of type `KeyValuePair`.

When the event is emitted, you expect for it to receive a parameter of type `string`.

Expand Down