Skip to content

Commit 9ea77cd

Browse files
committed
Adds comment for the startIdleNavigationSpan params
1 parent 6d12e05 commit 9ea77cd

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

packages/core/src/js/tracing/reactnavigation.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,9 @@ export const reactNavigationIntegration = ({
209209
* To be called on every React-Navigation action dispatch.
210210
* It does not name the transaction or populate it with route information. Instead, it waits for the state to fully change
211211
* and gets the route information from there, @see updateLatestNavigationSpanWithCurrentRoute
212+
*
213+
* @param unknownEvent - The event object that contains navigation action data
214+
* @param isAppRestart - Whether this span is being started due to an app restart rather than a normal navigation action
212215
*/
213216
const startIdleNavigationSpan = (unknownEvent?: unknown, isAppRestart = false): void => {
214217
const event = unknownEvent as UnsafeAction | undefined;

0 commit comments

Comments
 (0)