docs: add MaybeLink description

prismicio · Dec 17, 2024 · 8217ae6 · 8217ae6
1 parent 4073174
commit 8217ae6
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/types/migration/Link.ts b/src/types/migration/Link.ts
@@ -1,5 +1,18 @@
 import type { LinkType, OptionalLinkProperties } from "../value/link"
 
+/**
+ * Adds `OptionalLinkProperties` to any type that looks like a link object (one
+ * that includes a valid `link_type` property).
+ *
+ * @example
+ *
+ * ```ts
+ * type Example = MaybeLink<PrismicDocument | LinkField>
+ * // PrismicDocument | (LinkField & OptionalLinkProperties)
+ * ```
+ *
+ * @typeParam T - The type to augment.
+ */
 export type MaybeLink<T> =
 	| Exclude<T, { link_type: (typeof LinkType)[keyof typeof LinkType] }>
 	| (Extract<T, { link_type: (typeof LinkType)[keyof typeof LinkType] }> &