Skip to content

chore(types): Add examples for __experimental_startPath types #6987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 14, 2025
+7 −0
Merged

chore(types): Add examples for __experimental_startPath types #6987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8eb5c9e
chore: (types): Add examples for types
alexcarpenter Oct 14, 2025
eeb2d00
add changeset
alexcarpenter Oct 14, 2025
ba12555
Merge branch 'main' into alexcarpenter/start-path-examples
alexcarpenter Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fresh-pandas-dress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add example usage for `__experimental_startPath`.
2 changes: 2 additions & 0 deletions packages/types/src/clerk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1175,7 +1175,7 @@
*/
windowNavigate: (to: URL | string) => void;
},
) => Promise<unknown> | unknown;

Check warning on line 1178 in packages/types/src/clerk.ts

View workflow job for this annotation

GitHub Actions / Static analysis 

'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down Expand Up @@ -1496,6 +1496,7 @@
customPages?: CustomPage[];
/**
* Specify on which page the user profile modal will open.
* @example __experimental_startPath: '/members'
* @experimental
**/
__experimental_startPath?: string;
Expand Down Expand Up @@ -1527,6 +1528,7 @@
customPages?: CustomPage[];
/**
* Specify on which page the organization profile modal will open.
* @example __experimental_startPath: '/organization-members'
* @experimental
**/
__experimental_startPath?: string;
Expand Down
Loading