docs(front_matter): complete documentation (#4166)

denoland · Jan 11, 2024 · eb214d4 · eb214d4
1 parent 7cb9b20
commit eb214d4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/front_matter/create_extractor.ts b/front_matter/create_extractor.ts
@@ -7,16 +7,19 @@ import {
 
 type Format = "yaml" | "toml" | "json" | "unknown";
 
+/** Return type for {@linkcode Extractor}. */
 export type Extract<T> = {
   frontMatter: string;
   body: string;
   attrs: T;
 };
 
+/** Function return type for {@linkcode createExtractor}. */
 export type Extractor = <T = Record<string, unknown>>(
   str: string,
 ) => Extract<T>;
 
+/** Parser function type used alongside {@linkcode createExtractor}. */
 export type Parser = <T = Record<string, unknown>>(str: string) => T;
 
 function _extract<T>(