This module exports a single function that can be called with an ES2015 template string to signal that it represents a GROQ-query.
The result will be the exact same string as the input, - this is currently helpful for getting syntax highlighting in editors, but in the future it might also parse and validate queries, strip unncessary whitespace and similar.
Pairs well with vscode-sanity!
npm install --save groq
import groq from 'groq'
const query = groq`*[_type == 'products'][0...10]`
If you are using @sanity/codegen
you can use defineQuery
instead of groq
to
get type inference out of the box:
import {defineQuery} from 'groq'
const query = defineQuery(`*[_type == 'products'][0...10]`)
In the future we might merge defineQuery
with groq
, but this is currently not
100% supported by TypeScript.
Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches.
To get started with Sanity, please head over to our getting started guide
MIT-licensed. See LICENSE.