Skip to content

Commit 739e50a

Browse files
committed
Add JSDocs for stripBasename and enableAsyncRouteHandlers
1 parent 2e0a521 commit 739e50a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

packages/react/src/reactrouterv6-compat-utils.tsx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,19 @@ export interface ReactRouterOptions {
5757
useNavigationType: UseNavigationType;
5858
createRoutesFromChildren: CreateRoutesFromChildren;
5959
matchRoutes: MatchRoutes;
60+
/**
61+
* Whether to strip the basename from the pathname when creating transactions.
62+
*
63+
* This is useful for applications that use a basename in their routing setup.
64+
* @default false
65+
*/
6066
stripBasename?: boolean;
67+
/**
68+
* Enables support for async route handlers.
69+
*
70+
* This allows Sentry to track and instrument routes dynamically resolved from async handlers.
71+
* @default false
72+
*/
6173
enableAsyncRouteHandlers?: boolean;
6274
}
6375

0 commit comments

Comments
 (0)