Skip to content

Commit 7f61361

Browse files
docs(types): Document setActive reference for the hooks using it (#6692)
Co-authored-by: Robert Soriano <[email protected]>
1 parent fced4fc commit 7f61361

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

.changeset/fine-masks-judge.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

packages/types/src/hooks.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ export type UseSignInReturn =
131131
*/
132132
signIn: undefined;
133133
/**
134-
* A function that sets the active session.
134+
* A function that sets the active session. See the [reference doc](https://clerk.com/docs/references/javascript/clerk#set-active).
135135
*/
136136
setActive: undefined;
137137
}
@@ -155,7 +155,7 @@ export type UseSignUpReturn =
155155
*/
156156
signUp: undefined;
157157
/**
158-
* A function that sets the active session.
158+
* A function that sets the active session. See the [reference doc](https://clerk.com/docs/references/javascript/clerk#set-active).
159159
*/
160160
setActive: undefined;
161161
}
@@ -208,7 +208,7 @@ export type UseSessionListReturn =
208208
*/
209209
sessions: undefined;
210210
/**
211-
* A function that sets the active session and/or organization.
211+
* A function that sets the active session and/or organization. See the [reference doc](https://clerk.com/docs/references/javascript/clerk#set-active).
212212
*/
213213
setActive: undefined;
214214
}

0 commit comments

Comments
 (0)