From 014f15ea93ad77f073f0fe4c6f2344bd333af808 Mon Sep 17 00:00:00 2001 From: lihbr Date: Tue, 24 Jan 2023 15:57:17 +0100 Subject: [PATCH] feat: add `HTMLRichTextSerializer` export --- src/helpers/asHTML.ts | 10 ++++++++++ src/index.ts | 1 + 2 files changed, 11 insertions(+) diff --git a/src/helpers/asHTML.ts b/src/helpers/asHTML.ts index 28b369a4..f0569dbd 100644 --- a/src/helpers/asHTML.ts +++ b/src/helpers/asHTML.ts @@ -105,6 +105,16 @@ type ExtractTextTypeGeneric = 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 index 64c4ffe9..d83f5766 100644 --- 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.