Skip to Content
GraphQL Tools
DocumentationAPI@graphql-tools/executorsrcfunctionsgetVariableValues

Function: getVariableValues()

getVariableValues(schema, varDefNodes, inputs, options?): CoercedVariableValues

Defined in: packages/executor/src/execution/values.ts:28

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.

Parameters

schema

GraphQLSchema

varDefNodes

readonly VariableDefinitionNode[]

inputs

options?

maxErrors?

number

Returns

CoercedVariableValues