graphql/utilities/typedQueryDocumentNode.d.mts

A Query Language and Runtime which can target any service.

/** @category Typed Documents */
import type { DocumentNode, ExecutableDefinitionNode } from "../language/ast.mjs";
/**
 * Wrapper type that contains DocumentNode and types that can be deduced from it.
 * @typeParam TResponseData - Typed GraphQL response data shape.
 * @typeParam TRequestVariables - Typed GraphQL request variables shape.
 */
export interface TypedQueryDocumentNode<TResponseData = {
    [key: string]: any;
}, TRequestVariables = {
    [key: string]: any;
}> extends DocumentNode {
    /** Top-level executable and type-system definitions in this document. */
    readonly definitions: ReadonlyArray<ExecutableDefinitionNode>;
    /**
     * This type is used to ensure that the variables you pass in to the query are assignable to Variables
     * and that the Result is assignable to whatever you pass your result to. The method is never actually
     * implemented, but the type is valid because we list it as optional
     */
    __ensureTypesOfVariablesAndResultMatching?: (variables: TRequestVariables) => TResponseData;
}