Skip to main content

getVariableValues

Callable

  • getVariableValues(schema: GraphQLSchema, varDefNodes: readonly VariableDefinitionNode[], inputs: {}, options?: { hideSuggestions?: boolean; maxErrors?: number }): VariableValuesOrErrors

  • 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: {}
      • optionaloptions: { hideSuggestions?: boolean; maxErrors?: number }
        • optionalhideSuggestions: boolean
        • optionalmaxErrors: number

      Returns VariableValuesOrErrors