IReactSettingsSnapshot
Kind: interface
An immutable snapshot of the ReactInstanceSettings used to create the current React instance.
Properties
BundleAppId
readonly string BundleAppId
A read-only snapshot of the ReactInstanceSettings.BundleAppId property value at the time when the React instance was created.
The name of the app passed to the packager server via the 'app' query parameter.
BundleRootPath
readonly string BundleRootPath
A read-only snapshot of the ReactInstanceSettings.BundleRootPath property value at the time when the React instance was created.
Base path used for the location of the bundle.
DebugBundlePath
readonly string DebugBundlePath
A read-only snapshot of the ReactInstanceSettings.DebugBundlePath property value at the time when the React instance was created.
When loading from a bundle server (such as metro), this is the path that will be requested from the server.
DebuggerBreakOnNextLine
readonly bool DebuggerBreakOnNextLine
A read-only snapshot of the ReactInstanceSettings.DebuggerBreakOnNextLine property value at the time when the React instance was created.
For direct debugging, controls whether to break on the next line of JavaScript that is executed.
This can help debug issues hit early in the JavaScript bundle load.
Note: this is not supported with the Chakra JS engine which is the currently used JavaScript engine. As a workaround you could add the debugger keyword in the beginning of the bundle.
DebuggerPort
readonly uint16_t DebuggerPort
A read-only snapshot of the ReactInstanceSettings.DebuggerPort property value at the time when the React instance was created.
When UseDirectDebugger is enabled, this controls the port that the JavaScript engine debugger will run on.
JavaScriptBundleFile
readonly string JavaScriptBundleFile
A read-only snapshot of the ReactInstanceSettings.JavaScriptBundleFile property value at the time when the React instance was created.
The name of the JavaScript bundle file to load. This should be a relative path from BundleRootPath. The .bundle extension will be appended to the end, when looking for the bundle file.
RequestDevBundle
readonly bool RequestDevBundle
A read-only snapshot of the ReactInstanceSettings.RequestDevBundle property value at the time when the React instance was created.
When querying the bundle server for a bundle, should it request the dev bundle or release bundle.
RequestInlineSourceMap
readonly bool RequestInlineSourceMap
A read-only snapshot of the ReactInstanceSettings.RequestInlineSourceMap property value at the time when the React instance was created.
If set, the bundler will include the source maps inline (this will improve debugging experience, but for very large bundles it could have a significant performance hit)
SourceBundleHost
readonly string SourceBundleHost
A read-only snapshot of the ReactInstanceSettings.SourceBundleHost property value at the time when the React instance was created.
When using ReactInstanceSettings.UseFastRefresh, ReactInstanceSettings.UseLiveReload, or ReactInstanceSettings.UseWebDebugger this is the server hostname that will be used to load the bundle from.
SourceBundlePort
readonly uint16_t SourceBundlePort
A read-only snapshot of the ReactInstanceSettings.SourceBundlePort property value at the time when the React instance was created.
When using ReactInstanceSettings.UseFastRefresh, ReactInstanceSettings.UseLiveReload, or ReactInstanceSettings.UseWebDebugger this is the server port that will be used to load the bundle from.
UseDirectDebugger
readonly bool UseDirectDebugger
A read-only snapshot of the ReactInstanceSettings.UseDirectDebugger property value at the time when the React instance was created.
Enables debugging in the JavaScript engine (if supported).
For Chakra this enables debugging of the JS runtime directly within the app using Visual Studio -> Attach to process (Script)
UseFastRefresh
readonly bool UseFastRefresh
A read-only snapshot of the ReactInstanceSettings.UseFastRefresh property value at the time when the React instance was created.
Controls whether the instance triggers the hot module reload logic when it first loads the instance.
Most edits should be visible within a second or two without the instance having to reload.
Non-compatible changes still cause full reloads.
See Fast Refresh for more information on Fast Refresh.
UseWebDebugger
readonly bool UseWebDebugger
Deprecated: Debugging should be done using DirectDebugging rather than WebDebugger. Web debugging changes the app behavior and will be removed in a future version.
A read-only snapshot of the ReactInstanceSettings.UseWebDebugger property value at the time when the React instance was created.
Controls whether the instance JavaScript runs in a remote environment such as within a browser.
By default, this is using a browser navigated to http://localhost:8081/debugger-ui served by Metro/Haul.
Debugging will start as soon as the react native instance is loaded.