Skip to content

Commit 6df2725

Browse files
github-actions[bot]github-actions[bot]
authored
[ci] Update Typedoc (e3e77eb) (#2628)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 6f8b9b4 commit 6df2725

File tree

73 files changed

+678
-693
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+678
-693
lines changed

‎clerk-typedoc/backend/allowlist-identifier.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ The Backend `AllowlistIdentifier` object represents an identifier that has been
22

33
## Properties
44

5-
| Property | Type | Description |
6-
| -------------------------------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
7-
| <a id="createdat"></a> `createdAt` | `number` | The date when the allowlist identifier was first created. |
8-
| <a id="id"></a> `id` | `string` | A unique ID for the allowlist identifier. |
9-
| <a id="identifier"></a> `identifier` | `string` | The [identifier](/docs/authentication/configuration/sign-up-sign-in-options#identifiers) that was added to the allowlist. |
10-
| <a id="identifiertype"></a> `identifierType` | <code>"email_address" \| "phone_number" \| "web3_wallet"</code> | The type of the allowlist identifier. |
11-
| <a id="instanceid"></a> `instanceId?` | `string` | The ID of the instance that this allowlist identifier belongs to. |
12-
| <a id="invitationid"></a> `invitationId?` | `string` | The ID of the invitation sent to the identifier. |
13-
| <a id="updatedat"></a> `updatedAt` | `number` | The date when the allowlist identifier was last updated. |
5+
| Property | Type | Description |
6+
| -------------------------------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------- |
7+
| <a id="createdat"></a> `createdAt` | `number` | The date when the allowlist identifier was first created. |
8+
| <a id="id"></a> `id` | `string` | A unique ID for the allowlist identifier. |
9+
| <a id="identifier"></a> `identifier` | `string` | The identifier that was added to the allowlist. |
10+
| <a id="identifiertype"></a> `identifierType` | <code>"email_address" \| "phone_number" \| "web3_wallet"</code> | The type of the allowlist identifier. |
11+
| <a id="instanceid"></a> `instanceId?` | `string` | The ID of the instance that this allowlist identifier belongs to. |
12+
| <a id="invitationid"></a> `invitationId?` | `string` | The ID of the invitation sent to the identifier. |
13+
| <a id="updatedat"></a> `updatedAt` | `number` | The date when the allowlist identifier was last updated. |

‎clerk-typedoc/backend/auth-object.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Properties
22

3-
| Property | Type | Description |
4-
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5-
| <a id="debug"></a> `debug` | <code>() => \{ [key: string]: any; \}</code> | Used to help debug issues when using Clerk in development. |
6-
| <a id="gettoken"></a> `getToken` | <code>() => Promise\<null\> \| () => Promise\<string\> \| [ServerGetToken](../types/server-get-token.mdx) \| () => Promise\<null\></code> | A function that gets the current user's [session token](/docs/backend-requests/resources/session-tokens) or a [custom JWT template](/docs/backend-requests/jwt-templates). |
7-
| <a id="has"></a> `has` | <code>[CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx) \| () => false</code> | A function that checks if the user has an organization role or custom permission. |
8-
| <a id="tokentype"></a> `tokenType` | <code>null \| "api_key" \| "session_token" \| "m2m_token" \| "oauth_token"</code> | The allowed token type. |
3+
| Property | Type | Description |
4+
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5+
| <a id="debug"></a> `debug` | <code>() => \{ [key: string]: any; \}</code> | Used to help debug issues when using Clerk in development. |
6+
| <a id="gettoken"></a> `getToken` | <code>() => Promise\<null\> \| () => Promise\<string\> \| [ServerGetToken](../types/server-get-token.mdx) \| () => Promise\<null\></code> | A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates). |
7+
| <a id="has"></a> `has` | <code>[CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx) \| () => false</code> | A function that checks if the user has an organization role or custom permission. |
8+
| <a id="tokentype"></a> `tokenType` | <code>null \| "api_key" \| "session_token" \| "m2m_token" \| "oauth_token"</code> | The allowed token type. |

0 commit comments

Comments
 (0)