From eb214d4d1384f91344ebdba679246057d335a686 Mon Sep 17 00:00:00 2001 From: Asher Gomez Date: Thu, 11 Jan 2024 18:33:15 +1100 Subject: [PATCH] docs(front_matter): complete documentation (#4166) --- front_matter/create_extractor.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/front_matter/create_extractor.ts b/front_matter/create_extractor.ts index 24f1163540fb..d746f0d21e7e 100644 --- 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 = { frontMatter: string; body: string; attrs: T; }; +/** Function return type for {@linkcode createExtractor}. */ export type Extractor = >( str: string, ) => Extract; +/** Parser function type used alongside {@linkcode createExtractor}. */ export type Parser = >(str: string) => T; function _extract(