Class: GraphQL::StaticValidation::Validator

Inherits:

Object

• Object
• GraphQL::StaticValidation::Validator

Defined in:

lib/graphql/static_validation/validator.rb

Overview

Initialized with a GraphQL::Schema, then it can validate Language::Nodes::Documentss based on that schema.

By default, it’s used by Query

Examples:

Validate a query

validator = GraphQL::StaticValidation::Validator.new(schema: MySchema)
document = GraphQL.parse(query_string)
errors = validator.validate(document)

Instance Method Summary

• #initialize(schema:, rules: GraphQL::StaticValidation::ALL_RULES) ⇒ Validator constructor

  A new instance of Validator.

• #validate(query) ⇒ Array<Hash>

  Validate ‘document` against the schema.

Constructor Details

#initialize(schema:, rules: GraphQL::StaticValidation::ALL_RULES) ⇒ Validator

Returns a new instance of Validator.

Parameters:

• schema (GraphQL::Schema)
• rule (Array<#validate(context)>) —

  a list of rules to use when validating

# File 'lib/graphql/static_validation/validator.rb', line 15

def initialize(schema:, rules: GraphQL::StaticValidation::ALL_RULES)
  @schema = schema
  @rules = rules
end

Instance Method Details

#validate(query) ⇒ Array<Hash>

Validate ‘document` against the schema. Returns an array of message hashes.

Parameters:

• document (GraphQL::Language::Nodes::Document)

Returns:

• (Array<Hash>)

# File 'lib/graphql/static_validation/validator.rb', line 23

def validate(query)
  context = GraphQL::StaticValidation::ValidationContext.new(query)
  @rules.each do |rules|
    rules.new.validate(context)
  end
  context.visitor.visit(query.document)
  context.errors.map(&:to_h)
end