feat: add HTMLRichTextSerializer export

prismicio · Jan 24, 2023 · 014f15e · 014f15e
1 parent af81b62
commit 014f15e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/src/helpers/asHTML.ts b/src/helpers/asHTML.ts
@@ -105,6 +105,16 @@ type ExtractTextTypeGeneric<T> = T extends RichTextMapSerializerFunction<
 	? U
 	: never;
 
+/**
+ * Serializes a node from a Rich Text or Title field with a map or a function to HTML
+ *
+ * @see {@link HTMLRichTextMapSerializer} and {@link HTMLRichTextFunctionSerializer}
+ * @see Templating Rich Text and title fields from Prismic {@link https://prismic.io/docs/template-content-vanilla-javascript#rich-text-and-title}
+ */
+export type HTMLRichTextSerializer =
+	| HTMLRichTextMapSerializer
+	| HTMLRichTextFunctionSerializer;
+
 /**
  * Creates a default HTML Rich Text Serializer with a given Link Resolver providing
  * sensible and safe defaults for every node type

diff --git a/src/index.ts b/src/index.ts
@@ -85,6 +85,7 @@ export type {
 	HTMLMapSerializer,
 	HTMLFunctionSerializer,
 };
+export type { HTMLRichTextSerializer } from "./helpers/asHTML";
 
 //=============================================================================
 // Errors - Custom errors for Prismic APIs.