feature(conditionals): added jsdocs for ConditionalConfig

FormidableLabs · Jan 17, 2024 · d09ece4 · d09ece4
1 parent 77ade33
commit d09ece4
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/packages/groq-builder/src/commands/conditional-types.ts b/packages/groq-builder/src/commands/conditional-types.ts
@@ -102,6 +102,16 @@ export type ConditionalConfig<
   TKey extends string = string,
   TIsExhaustive extends boolean = boolean
 > = {
+  /**
+   * If using multiple conditions in a single projection,
+   * each condition must have a unique key.
+   * This key is not used in the resulting query, and can be anything.
+   */
   key: TKey;
+  /**
+   * If the conditional statements cover all possible scenarios,
+   * then setting `isExhaustive` to `true` will ensure stronger types,
+   * and can throw runtime errors if none of the conditions are satisfied.
+   */
   isExhaustive: TIsExhaustive;
 };
diff --git a/packages/groq-builder/src/commands/conditionalByType.ts b/packages/groq-builder/src/commands/conditionalByType.ts
@@ -1,5 +1,5 @@
 import { GroqBuilder } from "../groq-builder";
-import { RootConfig } from "../types/schema-types";
+import { ExtractTypeNames, RootConfig } from "../types/schema-types";
 import { ResultItem } from "../types/result-types";
 import {
   ExtractConditionalByTypeProjectionResults,
@@ -18,9 +18,12 @@ declare module "../groq-builder" {
         TRootConfig
       >,
       TKey extends string = "[ByType]",
-      TIsExhaustive extends boolean = TConditionalProjections extends Required<
-        ConditionalByTypeProjectionMap<ResultItem<TResult>, TRootConfig>
-      >
+      /**
+       * Did we supply a condition for all possible _type values?
+       */
+      TIsExhaustive extends boolean = ExtractTypeNames<
+        ResultItem<TResult>
+      > extends keyof TConditionalProjections
         ? true
         : false
     >(