Skip to content
Merged
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/busy-buttons-camp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
3 changes: 3 additions & 0 deletions .typedoc/custom-plugin.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ const FILES_WITHOUT_HEADINGS = [
'use-reverification-params.mdx',
'payment-element-provider-props.mdx',
'payment-element-props.mdx',
'use-organization-creation-defaults-return.mdx',
'use-organization-creation-defaults-params.mdx',
];

/**
Expand Down Expand Up @@ -90,6 +92,7 @@ const LINK_REPLACEMENTS = [
['billing-payment-resource', '/docs/reference/javascript/types/billing-payment-resource'],
['deleted-object-resource', '/docs/reference/javascript/types/deleted-object-resource'],
['use-checkout-return', '/docs/reference/hooks/use-checkout#returns'],
['organization-creation-defaults-resource', '#organization-creation-defaults-resource'],
];

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import type { ClerkAPIResponseError } from '../../errors/clerkApiResponseError';
import type { OrganizationCreationDefaultsResource } from '../../types';

/**
* @interface
*/
export type UseOrganizationCreationDefaultsParams = {
/**
* If true, the previous data will be kept in the cache until new data is fetched.
Expand All @@ -16,6 +19,9 @@ export type UseOrganizationCreationDefaultsParams = {
enabled?: boolean;
};

/**
* @interface
*/
export type UseOrganizationCreationDefaultsReturn = {
/**
* The organization creation defaults resource, `undefined` before the first fetch, or `null` if not available.
Expand Down
3 changes: 3 additions & 0 deletions packages/shared/src/types/organizationCreationDefaults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ export interface OrganizationCreationDefaultsJSON extends ClerkResourceJSON {
};
}

/**
* @interface
*/
export interface OrganizationCreationDefaultsResource extends ClerkResource {
advisory: {
code: OrganizationCreationAdvisoryType;
Expand Down