groq-builder/dist/commands/fragment.d.ts

A **schema-aware**, strongly-typed GROQ query builder. It enables you to build GROQ queries using **auto-completion**, **type-checking**, and **runtime validation**.

import { GroqBuilder } from "../groq-builder";
import { ExtractProjectionResult, ProjectionMap } from "./projection-types";
import { Fragment } from "../types/public-types";
import { ExtractDocumentTypes, QueryConfig } from "../types/schema-types";
import { RequireAFakeParameterIfThereAreTypeMismatchErrors } from "../types/utils";
declare module "../groq-builder" {
    interface GroqBuilder<TResult, TQueryConfig> {
        /**
         * Creates a fragment for any type you specify.
         * This is useful for inline types that do not have a top-level document type.
         *
         * @example
         * const keyValueFragment = q.fragment<{ key: string, value: number }>().project({
         *   key: q.string(),
         *   value: q.number(),
         * })
         */
        fragment<TFragmentInput>(): FragmentUtil<TQueryConfig, TFragmentInput>;
        /**
         * Creates a fragment for a Document, based on the document type.
         *
         * @example
         * const productFragment = q.fragmentForType<"product">().project(sub => ({
         *   name: q.string(),
         *   price: q.number(),
         *   images: sub.field("images[]").deref().project({
         *     width: q.number(),
         *     height: q.number(),
         *     url: q.string(),
         *   }),
         * }))
         */
        fragmentForType<TFragmentType extends ExtractDocumentTypes<TQueryConfig["schemaTypes"]>>(): FragmentUtil<TQueryConfig, Extract<TQueryConfig["schemaTypes"], {
            _type: TFragmentType;
        }>>;
    }
}
/**
 * When creating a Fragment, we return this utility object
 * that exposes a `project` method that has almost the same API
 * as the normal `project` method.
 */
export type FragmentUtil<TQueryConfig extends QueryConfig, TFragmentInput> = {
    /**
     * Performs an "object projection", returning an object with the fields specified.
     *
     * @param projectionMap - The projection map is an object, mapping field names to projection values
     * @param __projectionMapTypeMismatchErrors - (internal: this is only used for reporting errors from the projection)
     */
    project<TProjectionMap extends ProjectionMap<TFragmentInput>, _TProjectionResult = ExtractProjectionResult<TFragmentInput, TProjectionMap>>(projectionMap: TProjectionMap | ((q: GroqBuilder<TFragmentInput, TQueryConfig>) => TProjectionMap), ...__projectionMapTypeMismatchErrors: RequireAFakeParameterIfThereAreTypeMismatchErrors<_TProjectionResult>): Fragment<TProjectionMap, TFragmentInput>;
};