Contents

module GraphQL
  # Used for defined arguments ({Field}, {InputObjectType})
  #
  # {#name} must be a String.
  #
  # @example defining an argument for a field
  #   GraphQL::Field.define do
  #     # ...
  #     argument :favoriteFood, types.String, "Favorite thing to eat", default_value: "pizza"
  #   end
  #
  # @example defining an argument for an {InputObjectType}
  #   GraphQL::InputObjectType.define do
  #     argument :newName, !types.String
  #   end
  #
  class Argument
    include GraphQL::Define::InstanceDefinable
    accepts_definitions :name, :type, :description, :default_value
    lazy_defined_attr_accessor :type, :description, :default_value

    # @return [String] The name of this argument on its {GraphQL::Field} or {GraphQL::InputObjectType}
    def name
      ensure_defined
      @name
    end

    attr_writer :name
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
graphql-0.18.5	lib/graphql/argument.rb