feat(fff): ✨ provide generics for types

importantimport · Jun 28, 2023 · 2cc0b29 · 2cc0b29
1 parent 2e15730
commit 2cc0b29
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 7 deletions.
diff --git a/docs/version/1.1.md b/docs/version/1.1.md
@@ -10,6 +10,7 @@ title: 'Version 1.1'
 
 - Improve:
   - [DateTime](#datetime) no longer supports number
+  - Provide generics for types
 
 ## Base
 

diff --git a/packages/fff-flavored-frontmatter/src/types.ts b/packages/fff-flavored-frontmatter/src/types.ts
@@ -1,5 +1,20 @@
 /// <reference lib="dom" />
 
+/**
+ * Optional Type Util
+ * @public
+ * @typeParam T - whether to support optional types
+ * - undefined: all available
+ * - true: only optional types are supported
+ * - false: optional types are not supported
+ */
+export type FFFOptionalType<T extends (boolean | undefined), Required, Optional> =
+  T extends undefined
+    ? Required | Optional
+    : T extends true
+      ? Optional
+      : Required
+
 /**
  * Object Image
  * @public
@@ -75,16 +90,20 @@ export type FFFDateTime = {
 /**
  * Media Variables
  * @public
+ * @typeParam T - whether to support optional types
+ * - undefined: all available
+ * - true: only optional types are supported
+ * - false: optional types are not supported
  */
-export type FFFMedia = {
+export type FFFMedia<T extends (boolean | undefined) = undefined> = {
   /** the main image for article or photo post. */
-  image?: string | FFFImage
+  image?: FFFOptionalType<T, string, FFFImage>
   /** the image for multi-photo post. */
-  images?: string[] | FFFImage[]
+  images?: FFFOptionalType<T, string[], FFFImage[]>
   /** the main audio for audio post. */
-  audio?: string | FFFAudio
+  audio?: FFFOptionalType<T, string, FFFAudio>
   /** the main video for video post. */
-  video?: string | FFFVideo
+  video?: FFFOptionalType<T, string, FFFVideo>
   /** image alternate text. */
   alt?: string
 }
@@ -126,9 +145,13 @@ export type FFFExtra = {
 /**
  * Type definition of the {@link https://fff.js.org | FFF Flavored Frontmatter}.
  * @public
+ * @typeParam T - whether to support optional types
+ * - undefined: all available
+ * - true: only optional types are supported
+ * - false: optional types are not supported
  */
-export type FFFFlavoredFrontmatter = FFFBase &
+export type FFFFlavoredFrontmatter<T extends (boolean | undefined) = undefined> = FFFBase &
   FFFDateTime &
-  FFFMedia &
+  FFFMedia<T> &
   FFFMention &
   FFFExtra