fix(groq): provide tsdoc for groq template literal function

sanity-io · Dec 21, 2022 · f9520b2 · f9520b2 · vercel · Dec 21, 2022
1 parent afcc2f5
commit f9520b2
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/packages/groq/src/groq.ts b/packages/groq/src/groq.ts
@@ -1,3 +1,13 @@
+/**
+ * Pass-through groq template tag. This is a no-op, but it helps editor integrations
+ * understand that a string represents a GROQ query in order to provide syntax highlighting
+ * and other features.
+ *
+ * @param strings - Template string parts
+ * @param keys - Template string keys
+ * @returns The same string as the input
+ * @public
+ */
 export default function groq(strings: TemplateStringsArray, ...keys: any[]): string {
   const lastIndex = strings.length - 1
   return (