diff --git a/.changeset/gentle-tables-tell.md b/.changeset/gentle-tables-tell.md new file mode 100644 index 0000000..7dd828f --- /dev/null +++ b/.changeset/gentle-tables-tell.md @@ -0,0 +1,5 @@ +--- +"@lemonsqueezy/lemonsqueezy.js": patch +--- + +Added deprecated TSDoc tag for `dark` diff --git a/.changeset/tricky-poets-watch.md b/.changeset/tricky-poets-watch.md new file mode 100644 index 0000000..96f46a4 --- /dev/null +++ b/.changeset/tricky-poets-watch.md @@ -0,0 +1,5 @@ +--- +"@lemonsqueezy/lemonsqueezy.js": patch +--- + +Added "deprecated" TSDoc tag to the `dark` option diff --git a/src/checkouts/types.ts b/src/checkouts/types.ts index 7ac97b7..1ac58bb 100644 --- a/src/checkouts/types.ts +++ b/src/checkouts/types.ts @@ -148,7 +148,8 @@ type CheckoutOptions = { terms_privacy_color: string; /** - * `Deprecated` If `true`, use the dark theme. Use color options + * If `true`, use the dark theme. + * @deprecated Use color options instead. */ dark: boolean; }; @@ -306,7 +307,7 @@ type Attributes = { * - `button_color` - A custom hex color to use for the checkout button. * - `button_text_color` - A custom hex color to use for the text within the checkout button. * - `terms_privacy_color` - A custom hex color to use for the terms and privacy text on the checkout page. Used only on embedded checkouts. - * - `dark` - Deprecated. If `true`, use the dark theme. Use color options instead. + * - `dark` - If `true`, use the dark theme. Deprecated. Use color options instead. */ checkout_options: CheckoutOptions; /** @@ -466,7 +467,7 @@ export type NewCheckout = { * - `button_color` - A custom hex color to use for the checkout button. * - `button_text_color` - A custom hex color to use for the text within the checkout button. * - `terms_privacy_color` - A custom hex color to use for the terms and privacy text on the checkout page. Used only on embedded checkouts. - * - `dark` - Deprecated. If `true`, use the dark theme. Use color options instead. + * - `dark` - If `true`, use the dark theme. Deprecated. Use color options instead. */ checkoutOptions?: { /** @@ -554,7 +555,8 @@ export type NewCheckout = { termsPrivacyColor?: string; /** - * `Deprecated` If `true`, use the dark theme. Use color options + * If `true`, use the dark theme. + * @deprecated Use color options instead. */ dark?: boolean; };