How margelo/nitro works
Nitro Modules provides a React Native runtime for statically compiled JSI bindings, plus the optional nitrogen generator used by module authors. The main author workflow is to declare a HybridObject in TypeScript, generate platform bindings, implement it natively, then create and call it from JavaScript. Runtime support includes native object registration, JSI method conversion, platform type bridges, and hybrid views. The README documents the product-level workflow; source-index references and excerpts support only selected internal links, so unsampled relationships are omitted.
Main entry points: Type.ts Native type model · index.ts Generator entry · HybridObjectSpec.ts HybridObject model · HybridFunction.hpp JSI method calls
Components 21
Module authoring
- TypeScript specs
packages/react-native-nitro-test/src/specs/TestObject.nitro.ts
Nitrogen generator
- Generator entry
packages/nitrogen/src/index.ts - Generator config
packages/nitrogen/src/config/NitroConfig.ts - Platform analysis
packages/nitrogen/src/getPlatformSpecs.ts - HybridObject model
packages/nitrogen/src/syntax/HybridObjectSpec.ts - Native type model
packages/nitrogen/src/syntax/types/Type.ts - Type analysis
packages/nitrogen/src/syntax/createType.ts - Generated source model
packages/nitrogen/src/syntax/SourceFile.ts - C++ bindings
packages/nitrogen/src/syntax/c++/getForwardDeclaration.ts - Kotlin bridge
packages/nitrogen/src/syntax/kotlin/KotlinCxxBridgedType.ts - Swift bridge
packages/nitrogen/src/syntax/swift/SwiftCxxBridgedType.ts - Hybrid view generation
packages/nitrogen/src/views/CppHybridViewComponent.ts
Core runtime
- JavaScript API
packages/react-native-nitro-modules/src/NitroModules.ts - Hybrid object proxy
packages/react-native-nitro-modules/src/NitroModulesProxy.ts - Object registry
packages/react-native-nitro-modules/cpp/registry/HybridObjectRegistry.cpp - JSI method calls
packages/react-native-nitro-modules/cpp/core/HybridFunction.hpp - Object prototype
packages/react-native-nitro-modules/cpp/prototype/Prototype.hpp
Native platforms
- Android runtime
packages/react-native-nitro-modules/android/src/main/cpp/core/JHybridObject.cpp - iOS runtime
packages/react-native-nitro-modules/ios/core/HybridObject.swift - Native hybrid views
packages/react-native-nitro-modules/src/views/HybridView.ts
Other components
- Module author
Connections 21
- Module author → TypeScript specs: declares interface
README.md - TypeScript specs → Generator entry: generates bindings
README.md - Generator entry → Generator config: uses configuration
- Generator entry → Platform analysis: analyzes platforms
- Platform analysis → HybridObject model: identifies platforms
- Type analysis → Native type model: creates types
packages/nitrogen/src/syntax/createType.ts - HybridObject model → Native type model: models members
- Native type model → Generated source model: describes generated files
packages/nitrogen/src/syntax/SourceFile.ts - Native type model → C++ bindings: requests declarations
packages/nitrogen/src/syntax/types/HybridObjectType.ts - Native type model → Kotlin bridge: converts types
packages/nitrogen/src/syntax/kotlin/KotlinCxxBridgedType.ts - Native type model → Swift bridge: converts types
packages/nitrogen/src/syntax/swift/SwiftCxxBridgedType.ts - HybridObject model → Hybrid view generation: supplies view spec
packages/nitrogen/src/views/swift/SwiftHybridViewManager.ts - Module author → JavaScript API: uses module
README.md - JavaScript API → Hybrid object proxy: delegates access
- Hybrid object proxy → Object registry: requests object
- Object registry → JSI method calls: exposes methods
- Object prototype → JSI method calls: uses functions
packages/react-native-nitro-modules/cpp/prototype/Prototype.hpp - JSI method calls → Module author: returns result
README.md - Module author → Android runtime: implements natively
README.md - Module author → iOS runtime: implements natively
README.md - Module author → Native hybrid views: uses view components
README.md