Package Exports

groq
groq/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (groq) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

GROQ tagged template literal

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!

Installing

npm install --save groq

Usage

import groq from 'groq'

const query = groq`*[_type == 'products'][0...10]`

Automatic type inference

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.

What is Sanity? What is GROQ?

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

License

MIT-licensed. See LICENSE.