Browse Source

docs(email-plugin): Add missing doc block

Michael Bromley 1 year ago
parent
commit
1da470c040
1 changed files with 8 additions and 1 deletions
  1. 8 1
      packages/email-plugin/src/types.ts

+ 8 - 1
packages/email-plugin/src/types.ts

@@ -505,8 +505,15 @@ export type SetOptionalAddressFieldsFn<Event> = (
  * @since 3.1.0
  * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
- *
  */
 export type SetMetadataFn<Event> = (event: Event) => EmailMetadata | Promise<EmailMetadata>;
 
+/**
+ * @description
+ * Metadata that can be attached to an email via the {@link EmailEventHandler}`.setMetadata()` method.
+ *
+ * @since 3.1.0
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
 export type EmailMetadata = Record<string, any>;