ReactAndroid/com.facebook.react.module.annotations/ReactModule

ReactModule

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ReactModule(val name: String, val canOverrideExistingModule: Boolean = false, val needsEagerInit: Boolean = false, val hasConstants: Boolean = true, val isCxxModule: Boolean = false)

Annotation for use on com.facebook.react.bridge.BaseJavaModules to describe properties for that module.

Properties

canOverrideExistingModule

val canOverrideExistingModule: Boolean = false

True if you intend to override some other native module that was registered e.g. as part of a different package (such as the core one). Trying to override without returning true from this method is considered an error and will throw an exception during initialization. By default all modules return false.

hasConstants

val hasConstants: Boolean = true

Whether this module has constants to add, defaults to true as that is safer for when a correct annotation is not included

isCxxModule

val isCxxModule: Boolean = false

Indicates if a module is a C++ module or a Java Module

name

val name: String

Name used to require() this module from JavaScript.

needsEagerInit

val needsEagerInit: Boolean = false

Whether this module needs to be loaded immediately.