Class: GraphQL::StaticValidation::Error

Inherits:

Object

• Object
• GraphQL::StaticValidation::Error

Defined in:

lib/graphql/static_validation/error.rb

Overview

Generates GraphQL-compliant validation message.

Direct Known Subclasses

ArgumentLiteralsAreCompatibleError, ArgumentNamesAreUniqueError, ArgumentsAreDefinedError, DirectivesAreDefinedError, DirectivesAreInValidLocationsError, FieldsAreDefinedOnTypeError, FieldsHaveAppropriateSelectionsError, FieldsWillMergeError, FragmentNamesAreUniqueError, FragmentSpreadsArePossibleError, FragmentTypesExistError, FragmentsAreFiniteError, FragmentsAreNamedError, FragmentsAreOnCompositeTypesError, FragmentsAreUsedError, MutationRootExistsError, NoDefinitionsArePresentError, OperationNamesAreValidError, RequiredArgumentsArePresentError, RequiredInputObjectAttributesArePresentError, SubscriptionRootExistsError, UniqueDirectivesPerLocationError, VariableDefaultValuesAreCorrectlyTypedError, VariableNamesAreUniqueError, VariableUsagesAreAllowedError, VariablesAreInputTypesError, VariablesAreUsedAndDefinedError

Defined Under Namespace

Modules: ErrorHelper

Instance Attribute Summary

• #message ⇒ Object readonly

  Returns the value of attribute message.

• #path ⇒ Object

  Returns the value of attribute path.

Instance Method Summary

• #initialize(message, path: nil, nodes: []) ⇒ Error constructor

  A new instance of Error.

• #to_h ⇒ Object

  A hash representation of this Message.

Constructor Details

#initialize(message, path: nil, nodes: []) ⇒ Error

Returns a new instance of Error.

# File 'lib/graphql/static_validation/error.rb', line 19

def initialize(message, path: nil, nodes: [])
  @message = message
  @nodes = Array(nodes)
  @path = path
end

Instance Attribute Details

#message ⇒ Object (readonly)

Returns the value of attribute message.

# File 'lib/graphql/static_validation/error.rb', line 16

def message
  @message
end

#path ⇒ Object

Returns the value of attribute path.

# File 'lib/graphql/static_validation/error.rb', line 17

def path
  @path
end

Instance Method Details

#to_h ⇒ Object

A hash representation of this Message

# File 'lib/graphql/static_validation/error.rb', line 26

def to_h
  {
    "message" => message,
    "locations" => locations
  }.tap { |h| h["path"] = path unless path.nil? }
end