From f9520b2e978c9e355a3367249bd28a5f1e4f8dc2 Mon Sep 17 00:00:00 2001 From: Espen Hovlandsdal Date: Wed, 21 Dec 2022 13:54:24 -0800 Subject: [PATCH] fix(groq): provide tsdoc for groq template literal function --- packages/groq/src/groq.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/groq/src/groq.ts b/packages/groq/src/groq.ts index b8188901174..024c387f1c2 100644 --- 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 (