Skip to content

docs(types): Document setActive reference for the hooks using it #6692

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 2 commits into from
Sep 3, 2025
+5 −3
Merged

docs(types): Document setActive reference for the hooks using it #6692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8af1e13
Document setActive reference
SarahSoutoul Sep 2, 2025
2624343
chore: placeholder changeset
wobsoriano Sep 3, 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
2 changes: 2 additions & 0 deletions .changeset/fine-masks-judge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
6 changes: 3 additions & 3 deletions packages/types/src/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export type UseSignInReturn =
*/
signIn: undefined;
/**
* A function that sets the active session.
* A function that sets the active session. See the [reference doc](https://clerk.com/docs/references/javascript/clerk#set-active).
*/
setActive: undefined;
}
Expand All @@ -155,7 +155,7 @@ export type UseSignUpReturn =
*/
signUp: undefined;
/**
* A function that sets the active session.
* A function that sets the active session. See the [reference doc](https://clerk.com/docs/references/javascript/clerk#set-active).
*/
setActive: undefined;
}
Expand Down Expand Up @@ -208,7 +208,7 @@ export type UseSessionListReturn =
*/
sessions: undefined;
/**
* A function that sets the active session and/or organization.
* A function that sets the active session and/or organization. See the [reference doc](https://clerk.com/docs/references/javascript/clerk#set-active).
*/
setActive: undefined;
}
Expand Down