groq-builder: Added `q.fragment` implementation

FormidableLabs / groqd

A schema-unaware, runtime and type-safe query builder for GROQ.

MIT License

221 stars 17 forks source link

Implemented q.fragment method for defining reusable fragments.

Examples

Defining a fragment:

const productFragment = q.fragment<SanitySchema.Product>().project(qProduct => ({
  name: true,
  price: true,
  imageUrls: qProduct.field('images[]').deref().field('url'),
}));

type ProductFragment = InferFragmentType<typeof productFragment>;
// Evaluates to: { name: string, price: number, imageUrls: Array<string> }

Consuming a fragment

You can pass to project:

q.star.filterByType('product').project(productFragment);

You can spread inside a project:

q.star.filterByType('product').project({
  ...productFragment,
  description: true,
  category: true,
});

You can compose multiple fragments by spreading.

TODO

[x] Implementation
[x] Unit tests
[x] Documentation

FormidableLabs / groqd

groq-builder: Added `q.fragment` implementation #250

Examples

Defining a fragment:

Consuming a fragment

TODO