Represents a non-leaf node in a GraphQL tree of information.

Objects represent a list of named fields, each of which yield a value of a specific type. Object values are serialized as unordered maps, where the queried field names (or aliases) are the keys and the result of evaluating the field is the value.

Also see Absinthe.Type.Scalar.

Examples

Given a type defined as the following (see Absinthe.Schema.Notation.object/3):

@desc "A person"
object :person do
  field :name, :string
  field :age, :integer
  field :best_friend, :person
  field :pets, list_of(:pet)
end

The “Person” type (referred inside Absinthe as :person) is an object, with fields that use Absinthe.Type.Scalar types (namely :name and :age), and other Absinthe.Type.Object types (:best_friend and :pets, assuming :pet is an object).

Given we have a query that supports getting a person by name (see Absinthe.Schema), and a query document like the following:

{
  person(name: "Joe") {
    name
    best_friend {
      name
      age
    }
    pets {
      breed
    }
  }
}

We could get a result like this:

%{
  data: %{
    "person" => %{
      "best_friend" => %{
        "name" => "Jill",
        "age" => 29
      },
      "pets" => [
        %{"breed" => "Wyvern"},
        %{"breed" => "Royal Griffon"}
      ]
    }
  }
}