Class: GraphQL::Argument

Inherits:
Object
  • Object
show all
Includes:
Define::InstanceDefinable
Defined in:
lib/graphql/argument.rb

Overview

Used for defined arguments (Field, InputObjectType)

#name must be a String.

Examples:

defining an argument for a field

GraphQL::Field.define do
  # ...
  argument :favoriteFood, types.String, "Favorite thing to eat", default_value: "pizza"
end

defining an input field for an InputObjectType

GraphQL::InputObjectType.define do
  input_field :newName, !types.String
end

Instance Attribute Summary collapse

Method Summary

Methods included from Define::InstanceDefinable

#definition_proc=, included, #metadata

Instance Attribute Details

#nameString

Returns The name of this argument on its Field or InputObjectType.

Returns:



23
24
25
26
# File 'lib/graphql/argument.rb', line 23

def name
  ensure_defined
  @name
end