Module: GraphQL::Relay::Node

Defined in:
lib/graphql/relay/node.rb

Overview

Helpers for working with Relay-specific Node objects.

Defined Under Namespace

Modules: FindNode

Class Method Summary collapse

Class Method Details

.field ⇒ GraphQL::Field

Returns a field for finding objects by their global ID.

Returns:

  • (GraphQL::Field) —

    a field for finding objects by their global ID.



6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/graphql/relay/node.rb', line 6

def self.field
  # We have to define it fresh each time because
  # its name will be modified and its description
  # _may_ be modified.
  GraphQL::Field.define do
    type(GraphQL::Relay::Node.interface)
    description("Fetches an object given its ID")
    argument(:id, !types.ID, "ID of the object")
    resolve(GraphQL::Relay::Node::FindNode)
  end
end

.interface ⇒ GraphQL::InterfaceType

Returns The interface which all Relay types must implement.

Returns:



19
20
21
22
23
24
 
# File 'lib/graphql/relay/node.rb', line 19

def self.interface
  @interface ||= GraphQL::InterfaceType.define do
    name "Node"
    field :id, !types.ID
  end
end