Skip to content

[ci] Update docs (2025-05-22) #11

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[ci] Update docs (2025-05-22) #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions nextjs/create-async-get-auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@ Should be used with function like `auth()` that are already asynchronous.

### Parameters

| Parameter | Type |
| ----------------- | -------------------------------------- |
| `req` | `RequestLike` |
| `opts?` | <code>\{ secretKey?: string; \}</code> |
| `opts.secretKey?` | `string` |
| Parameter | Type |
| --------- | ---------------------------------------------------------------------------------------------- |
| `req` | `RequestLike` |
| `opts?` | <code>\{ secretKey?: string; \}</code> & <code>\{ treatPendingAsSignedOut?: boolean; \}</code> |

### Returns

Expand Down
11 changes: 5 additions & 6 deletions nextjs/create-sync-get-auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Previous known as `createGetAuth`. We needed to create a sync and async variant in order to allow for improvements
that required dynamic imports (using `require` would not work).
It powers the synchronous top-level api `getAuh()`.
It powers the synchronous top-level api `getAuth()`.

## Parameters

Expand All @@ -14,11 +14,10 @@ It powers the synchronous top-level api `getAuh()`.

### Parameters

| Parameter | Type |
| ----------------- | -------------------------------------- |
| `req` | `RequestLike` |
| `opts?` | <code>\{ secretKey?: string; \}</code> |
| `opts.secretKey?` | `string` |
| Parameter | Type |
| --------- | ---------------------------------------------------------------------------------------------- |
| `req` | `RequestLike` |
| `opts?` | <code>\{ secretKey?: string; \}</code> & <code>\{ treatPendingAsSignedOut?: boolean; \}</code> |

### Returns

Expand Down
9 changes: 4 additions & 5 deletions nextjs/get-auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ The `getAuth()` helper retrieves authentication state from the request object.

## Parameters

| Parameter | Type | Description |
| ----------------- | -------------------------------------- | --------------------------- |
| `req` | `RequestLike` | The Next.js request object. |
| `opts?` | <code>\{ secretKey?: string; \}</code> | - |
| `opts.secretKey?` | `string` | - |
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------- | --------------------------- |
| `req` | `RequestLike` | The Next.js request object. |
| `opts?` | <code>\{ secretKey?: string; \}</code> & <code>\{ treatPendingAsSignedOut?: boolean; \}</code> | - |

## Returns

Expand Down
16 changes: 8 additions & 8 deletions shared/use-organization-list-return.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
| Property | Type | Description |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| <a id="createorganization"></a> `createOrganization` | <code>undefined \| ([CreateOrganizationParams](#create-organization-params)) => Promise\<[OrganizationResource](/docs/references/javascript/organization)\></code> | A function that returns a `Promise` which resolves to the newly created `Organization`. |
| <a id="isloaded"></a> `isLoaded` | `boolean` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. |
| <a id="setactive"></a> `setActive` | <code>undefined \| ([setActiveParams](/docs/references/javascript/types/set-active-params)) => Promise\<void\></code> | A function that sets the active session and/or organization. |
| <a id="userinvitations"></a> `userInvitations` | <code>PaginatedResourcesWithDefault\<[UserOrganizationInvitationResource](/docs/references/javascript/types/user-organization-invitation)\> \| [PaginatedResources](#paginated-resources)\<[UserOrganizationInvitationResource](/docs/references/javascript/types/user-organization-invitation), T\["userInvitations"\] _extends_ \{ infinite: true; \} ? true : false\></code> | Returns `PaginatedResources` which includes a list of the user's organization invitations. |
| <a id="usermemberships"></a> `userMemberships` | <code>PaginatedResourcesWithDefault\<[OrganizationMembershipResource](/docs/references/javascript/types/organization-membership)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationMembershipResource](/docs/references/javascript/types/organization-membership), T\["userMemberships"\] _extends_ \{ infinite: true; \} ? true : false\></code> | Returns `PaginatedResources` which includes a list of the user's organization memberships. |
| <a id="usersuggestions"></a> `userSuggestions` | <code>PaginatedResourcesWithDefault\<[OrganizationSuggestionResource](/docs/references/javascript/types/organization-suggestion)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationSuggestionResource](/docs/references/javascript/types/organization-suggestion), T\["userSuggestions"\] _extends_ \{ infinite: true; \} ? true : false\></code> | Returns `PaginatedResources` which includes a list of suggestions for organizations that the user can join. |
| Property | Type | Description |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="createorganization"></a> `createOrganization` | <code>undefined \| ([CreateOrganizationParams](#create-organization-params)) => Promise\<[OrganizationResource](/docs/references/javascript/organization)\></code> | A function that returns a `Promise` which resolves to the newly created `Organization`. |
| <a id="isloaded"></a> `isLoaded` | `boolean` | A boolean that indicates whether Clerk has completed initialization and there is an authenicated user. Initially `false`, becomes `true` once Clerk loads with a user |
| <a id="setactive"></a> `setActive` | <code>undefined \| ([setActiveParams](/docs/references/javascript/types/set-active-params)) => Promise\<void\></code> | A function that sets the active session and/or organization. |
| <a id="userinvitations"></a> `userInvitations` | <code>PaginatedResourcesWithDefault\<[UserOrganizationInvitationResource](/docs/references/javascript/types/user-organization-invitation)\> \| [PaginatedResources](#paginated-resources)\<[UserOrganizationInvitationResource](/docs/references/javascript/types/user-organization-invitation), T\["userInvitations"\] _extends_ \{ infinite: true; \} ? true : false\></code> | Returns `PaginatedResources` which includes a list of the user's organization invitations. |
| <a id="usermemberships"></a> `userMemberships` | <code>PaginatedResourcesWithDefault\<[OrganizationMembershipResource](/docs/references/javascript/types/organization-membership)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationMembershipResource](/docs/references/javascript/types/organization-membership), T\["userMemberships"\] _extends_ \{ infinite: true; \} ? true : false\></code> | Returns `PaginatedResources` which includes a list of the user's organization memberships. |
| <a id="usersuggestions"></a> `userSuggestions` | <code>PaginatedResourcesWithDefault\<[OrganizationSuggestionResource](/docs/references/javascript/types/organization-suggestion)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationSuggestionResource](/docs/references/javascript/types/organization-suggestion), T\["userSuggestions"\] _extends_ \{ infinite: true; \} ? true : false\></code> | Returns `PaginatedResources` which includes a list of suggestions for organizations that the user can join. |