diff --git a/.changeset/quick-ways-cross.md b/.changeset/quick-ways-cross.md new file mode 100644 index 000000000..616f56a59 --- /dev/null +++ b/.changeset/quick-ways-cross.md @@ -0,0 +1,9 @@ +--- +"@react-email/render": major +--- + +Removes deprecated `renderAsync`. + +## Migration + +Replace `renderAsync` with `render`. It should be a drop-in replacement, without any issues. diff --git a/packages/render/src/browser/index.ts b/packages/render/src/browser/index.ts index fccaf8ffd..44fd94089 100644 --- a/packages/render/src/browser/index.ts +++ b/packages/render/src/browser/index.ts @@ -1,13 +1,3 @@ -import type { Options } from '../shared/options'; -import { render } from './render'; - -/** - * @deprecated use {@link render} - */ -export const renderAsync = (element: React.ReactElement, options?: Options) => { - return render(element, options); -}; - export * from '../shared/options'; export * from '../shared/utils/pretty'; export * from '../shared/utils/to-plain-text'; diff --git a/packages/render/src/edge/index.ts b/packages/render/src/edge/index.ts index fccaf8ffd..44fd94089 100644 --- a/packages/render/src/edge/index.ts +++ b/packages/render/src/edge/index.ts @@ -1,13 +1,3 @@ -import type { Options } from '../shared/options'; -import { render } from './render'; - -/** - * @deprecated use {@link render} - */ -export const renderAsync = (element: React.ReactElement, options?: Options) => { - return render(element, options); -}; - export * from '../shared/options'; export * from '../shared/utils/pretty'; export * from '../shared/utils/to-plain-text'; diff --git a/packages/render/src/node/index.ts b/packages/render/src/node/index.ts index fccaf8ffd..44fd94089 100644 --- a/packages/render/src/node/index.ts +++ b/packages/render/src/node/index.ts @@ -1,13 +1,3 @@ -import type { Options } from '../shared/options'; -import { render } from './render'; - -/** - * @deprecated use {@link render} - */ -export const renderAsync = (element: React.ReactElement, options?: Options) => { - return render(element, options); -}; - export * from '../shared/options'; export * from '../shared/utils/pretty'; export * from '../shared/utils/to-plain-text'; diff --git a/packages/render/src/shared/options.ts b/packages/render/src/shared/options.ts index 3cc9b672b..f0d98eeee 100644 --- a/packages/render/src/shared/options.ts +++ b/packages/render/src/shared/options.ts @@ -4,19 +4,19 @@ import type { toPlainText } from './utils/to-plain-text'; export type Options = { /** - * @deprecated use {@link pretty} instead + * @see {@link pretty} */ pretty?: boolean; } & ( | { /** - * @deprecated use {@link toPlainText} instead + * @see {@link toPlainText} */ plainText?: false; } | { /** - * @deprecated use {@link toPlainText} instead + * @see {@link toPlainText} */ plainText?: true; /**