@graphql-tools/executor
Version:
Fork of GraphQL.js' execute function
24 lines (23 loc) • 955 B
text/typescript
import { GraphQLError, GraphQLSchema, VariableDefinitionNode } from 'graphql';
import { VariableValues } from '@graphql-tools/utils';
export type VariableValuesOrErrors = {
errors: ReadonlyArray<GraphQLError>;
variableValues?: never;
} | {
variableValues: VariableValues;
errors?: never;
};
/**
* Prepares an object map of variableValues of the correct type based on the
* provided variable definitions and arbitrary input. If the input cannot be
* parsed to match the variable definitions, a GraphQLError will be thrown.
*
* Note: The returned value is a plain Object with a prototype, since it is
* exposed to user code. Care should be taken to not pull values from the
* Object prototype.
*/
export declare function getVariableValues(schema: GraphQLSchema, varDefNodes: ReadonlyArray<VariableDefinitionNode>, inputs: {
readonly [variable: string]: unknown;
}, options?: {
maxErrors?: number;
}): VariableValuesOrErrors;