✨ add comment explaining getFirstBlockOfType

owid · Feb 20, 2025 · 79c6628 · 79c6628
1 parent 7ba2c61
commit 79c6628
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/site/gdocs/utils.ts b/site/gdocs/utils.ts
@@ -189,6 +189,11 @@ export const getTopSubnavigationParentItem = (
     return subnavs[subnavId]?.[0]
 }
 
+/**
+ * Takes a gdoc and a block type and returns the first block of that type found in the gdoc
+ * e.g. getFirstBlockOfType(gdoc, "image") will return the first image block in the gdoc
+ * and it will be typed correctly as an EnrichedBlockImage
+ **/
 export function getFirstBlockOfType<
     T extends keyof OwidEnrichedGdocBlockTypeMap,
 >(