Type Alias: StartOptions
StartOptions =
object
Defined in: packages/expo-binary-module/src/types/startOptions.ts:42
Properties
autoStart?
optionalautoStart?:boolean
Defined in: packages/expo-binary-module/src/types/startOptions.ts:48
Whether to auto-start binary on app start and device reboot.
Default: false
autoStartDelay?
optionalautoStartDelay?:number
Defined in: packages/expo-binary-module/src/types/startOptions.ts:54
Number of seconds to delay before auto starting Default: 0
autoStop?
optionalautoStop?:AutoStopOptions|null
Defined in: packages/expo-binary-module/src/types/startOptions.ts:68
Auto stop options. While technically the binary is stopped and restarted, this effectively auto-pauses and resumes based on device network and battery statuses.
If provided and binary was previously started but not manually stopped, it will monitor device network & battery status and automatically stop the binary when conditions are met. And then restart binary when conditions no longer meet.
To disable use undefined/null
Default: { batteryLevelBelow: 10, networkTypes: ['cellular' ]}
binaryName
binaryName:
string
Defined in: packages/expo-binary-module/src/types/startOptions.ts:77
Name of the binary file to be executed.
The binary file must be available in the jniLibs directory.
For more details, check out the jniLibs Configuration section in the README.md.
env?
optionalenv?:BinaryEnv
Defined in: packages/expo-binary-module/src/types/startOptions.ts:85
Record containing environment varibles to be passed to the binary.
Key: string. environment variable name. Value: EnvEntry variable configuration.
ipcOptions?
optionalipcOptions?:IpcOptions
Defined in: packages/expo-binary-module/src/types/startOptions.ts:94
Options for InterProcess Communication (IPC) from the executed binary to the React Native app.
How this works?
If enabled (by setting a tag), the binary service will monitor each line printed by executed binary and create a notification if matched. See IpcNotificationOptions.tag
notification?
optionalnotification?:Partial<NotificationOptions>
Defined in: packages/expo-binary-module/src/types/startOptions.ts:97
Default notification options used with foreground service notification
startupText?
optionalstartupText?:string
Defined in: packages/expo-binary-module/src/types/startOptions.ts:100
Optionally, provide a case-insensitive text to match binary log outputs to confirm successful start
startupTimeout?
optionalstartupTimeout?:number
Defined in: packages/expo-binary-module/src/types/startOptions.ts:108
Startup timeout duration in seconds. If startupText does not appear in the log within this duration, it will be assumed that startup has failed.
Default: 30