module GraphQL

typed: true

typed: false

typed: true

frozen_string_literal: true

typed: true

typed: ignore

typed: true

Constants

Dashboard: Rails expects the engine to be called Graphql::Dashboard, but GraphQL::Dashboard is consistent with this gem’s naming. So define both constants to refer to the same class.
VERSION

Attributes

default_parser [W]

reject_numbers_followed_by_names [RW]

If true, the parser should raise when an integer or float is followed immediately by an identifier (instead of a space or punctuation)

Public Class Methods

default_parser() → Class

Source

# File lib/graphql.rb, line 52
def default_parser
  @default_parser ||= GraphQL::Language::Parser
end

Get the parser used by GraphQL.parse and GraphQL.parse_file.

Returns

Class — the configured parser class

eager_load! ()

() → void

Source

# File lib/graphql.rb, line 19
def self.eager_load!
  super
  Query.eager_load!
  Types.eager_load!
  Schema.eager_load!
end

Load all autoload-configured classes, and also eager-load dependents who have autoloads of their own.

This is useful during application boot when autoloading is disabled or when a framework needs to eager-load its namespaces.

Calls superclass method

parse(String graphql_string, trace:, filename:, max_tokens:) → GraphQL::Language::Nodes::Document

(String, ?trace: GraphQL::Tracing::Trace, ?filename: String?, ?max_tokens: Integer?) → GraphQL::Language::Nodes::Document

Source

# File lib/graphql.rb, line 72
def self.parse(graphql_string, trace: GraphQL::Tracing::NullTrace, filename: nil, max_tokens: nil)
  default_parser.parse(graphql_string, trace: trace, filename: filename, max_tokens: max_tokens)
end

Turn a query string or schema definition into an AST

Parameters

graphql_string (String) — a GraphQL query string or schema definition

Returns

GraphQL::Language::Nodes::Document

parse_file(String filename) → GraphQL::Language::Nodes::Document

(String) → GraphQL::Language::Nodes::Document

Source

# File lib/graphql.rb, line 89
def self.parse_file(filename)
  content = File.read(filename)
  default_parser.parse(content, filename: filename)
end

Read the contents of filename and parse them as GraphQL

Parameters

filename (String) — Path to a .graphql file containing IDL or query

Returns

GraphQL::Language::Nodes::Document

parse_with_racc (string, filename: nil, trace: GraphQL::Tracing::NullTrace)

Source

# File lib/graphql.rb, line 94
def self.parse_with_racc(string, filename: nil, trace: GraphQL::Tracing::NullTrace)
  warn "`GraphQL.parse_with_racc` is deprecated; GraphQL-Ruby no longer uses racc for parsing. Call `GraphQL.parse` or `GraphQL::Language::Parser.parse` instead."
  GraphQL::Language::Parser.parse(string, filename: filename, trace: trace)
end

scan_with_ruby (graphql_string)

Source

# File lib/graphql.rb, line 99
def self.scan_with_ruby(graphql_string)
  GraphQL::Language::Lexer.tokenize(graphql_string)
end