diff --git a/.changeset/lucky-scissors-admire.md b/.changeset/lucky-scissors-admire.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/lucky-scissors-admire.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/packages/shared/src/react/hooks/useOrganization.tsx b/packages/shared/src/react/hooks/useOrganization.tsx index 9766524d52c..3959db652b5 100644 --- a/packages/shared/src/react/hooks/useOrganization.tsx +++ b/packages/shared/src/react/hooks/useOrganization.tsx @@ -69,7 +69,7 @@ export type UseOrganizationParams = { export type UseOrganizationReturn = | { /** - * 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, and can revert to `false` while auth state is updating (for example, when switching organizations via `setActive()`). */ isLoaded: false; /** diff --git a/packages/shared/src/react/hooks/useOrganizationList.tsx b/packages/shared/src/react/hooks/useOrganizationList.tsx index 18448f5b2c3..d1774640619 100644 --- a/packages/shared/src/react/hooks/useOrganizationList.tsx +++ b/packages/shared/src/react/hooks/useOrganizationList.tsx @@ -77,7 +77,7 @@ const undefinedPaginatedResource = { export type UseOrganizationListReturn = | { /** - * 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 and there is an authenticated user. Initially `false`, becomes `true` once Clerk loads with a user, and can revert to `false` while auth state is updating (for example, when switching organizations via `setActive()`). */ isLoaded: false; /** diff --git a/packages/shared/src/types/hooks.ts b/packages/shared/src/types/hooks.ts index 8babc35277a..dfd6167f4b4 100644 --- a/packages/shared/src/types/hooks.ts +++ b/packages/shared/src/types/hooks.ts @@ -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, and can revert to `false` while auth state is updating (for example, when switching organizations via `setActive()`). */ isLoaded: false; /** @@ -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, and can revert to `false` while auth state is updating (for example, when switching organizations via `setActive()`). */ isLoaded: false; /** @@ -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, and can revert to `false` while auth state is updating (for example, when switching organizations via `setActive()`). */ isLoaded: false; /**