GraphQLObjectType <TSource, TContext>

Object Type Definition

Almost all of the GraphQL types you define will be object types. Object types have a name, but most importantly describe their fields.

Example:

const AddressType = new GraphQLObjectType({
  name: 'Address',
  fields: {
    street: { type: GraphQLString },
    number: { type: GraphQLInt },
    formatted: {
      type: GraphQLString,
      resolve(obj) {
        return obj.number + ' ' + obj.street
      }
    }
  }
});

When two types need to refer to each other, or a type needs to refer to itself in a field, you can use a function expression (aka a closure or a thunk) to supply the fields lazily.

Example:

const PersonType = new GraphQLObjectType({
  name: 'Person',
  fields: () => ({
    name: { type: GraphQLString },
    bestFriend: { type: PersonType },
  })
});

Index

Constructors

• constructor

Properties

• astNode
• description
• extensionASTNodes
• extensions
• isTypeOf
• name

Accessors

• [toStringTag]

Methods

• getFields
• getInterfaces
• toConfig
• toJSON
• toString

Constructors

constructor

• new GraphQLObjectType<TSource, TContext>(config: Readonly<GraphQLObjectTypeConfig<TSource, TContext>>): GraphQLObjectType<TSource, TContext>

• Type parameters

  • TSource = any
  • TContext = any

  Parameters

  • config: Readonly<GraphQLObjectTypeConfig<TSource, TContext>>

  Returns GraphQLObjectType<TSource, TContext>

Properties

astNode

astNode: Maybe<ObjectTypeDefinitionNode>

description

description: Maybe<string>

extensionASTNodes

extensionASTNodes: readonly ObjectTypeExtensionNode[]

extensions

extensions: Readonly<GraphQLObjectTypeExtensions<TSource, TContext>>

isTypeOf

isTypeOf: Maybe<GraphQLIsTypeOfFn<TSource, TContext>>

name

name: string

Accessors

[toStringTag]

• get [toStringTag](): string

• Returns string

Methods

getFields

• getFields(): GraphQLFieldMap<TSource, TContext>

• Returns GraphQLFieldMap<TSource, TContext>

getInterfaces

• getInterfaces(): readonly GraphQLInterfaceType<any, any>[]

• Returns readonly GraphQLInterfaceType<any, any>[]

toConfig

• toConfig(): GraphQLObjectTypeNormalizedConfig<TSource, TContext>

• Returns GraphQLObjectTypeNormalizedConfig<TSource, TContext>

toJSON

• toJSON(): string

• Returns string

toString

• toString(): string

• Returns string