Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/lucky-scissors-admire.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOrganization.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export type UseOrganizationParams = {
export type UseOrganizationReturn<T extends UseOrganizationParams> =
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
* A boolean that indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads but may temporarily return to `false` while auth state is updating, such as when switching organizations.
*/
isLoaded: false;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOrganizationList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ const undefinedPaginatedResource = {
export type UseOrganizationListReturn<T extends UseOrganizationListParams> =
| {
/**
* A boolean that indicates whether Clerk has completed initialization and there is an authenticated user. Initially `false`, becomes `true` once Clerk loads with a user.
* A boolean that indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads but may temporarily return to `false` while auth state is updating, such as when switching organizations.
*/
isLoaded: false;
/**
Expand Down
12 changes: 6 additions & 6 deletions packages/shared/src/types/hooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ type CheckAuthorizationSignedOut = CheckAuthorizationWithoutOrgOrUser;
export type UseAuthReturn =
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
* A boolean that indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads but may temporarily return to `false` while auth state is updating, such as when switching organizations.
*/
isLoaded: false;
/**
Expand Down Expand Up @@ -123,7 +123,7 @@ export type UseAuthReturn =
export type UseSignInReturn =
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
* A boolean that indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads but may temporarily return to `false` while auth state is updating, such as when switching organizations.
*/
isLoaded: false;
/**
Expand All @@ -147,7 +147,7 @@ export type UseSignInReturn =
export type UseSignUpReturn =
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
* A boolean that indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads but may temporarily return to `false` while auth state is updating, such as when switching organizations.
*/
isLoaded: false;
/**
Expand All @@ -171,7 +171,7 @@ export type UseSignUpReturn =
export type UseSessionReturn =
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
* A boolean that indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads but may temporarily return to `false` while auth state is updating, such as when switching organizations.
*/
isLoaded: false;
/**
Expand Down Expand Up @@ -200,7 +200,7 @@ export type UseSessionReturn =
export type UseSessionListReturn =
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
* A boolean that indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads but may temporarily return to `false` while auth state is updating, such as when switching organizations.
*/
isLoaded: false;
/**
Expand All @@ -224,7 +224,7 @@ export type UseSessionListReturn =
export type UseUserReturn =
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
* A boolean that indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads but may temporarily return to `false` while auth state is updating, such as when switching organizations.
*/
isLoaded: false;
/**
Expand Down
Loading