Skip to main content

GraphQLInterfaceType

Interface Type Definition

When a field can return one of a heterogeneous set of types, a Interface type is used to describe what types are possible, what fields are in common across all types, as well as a function to determine which type is actually used when the field is resolved.

Example:

const EntityType = new GraphQLInterfaceType({
name: 'Entity',
fields: {
name: { type: GraphQLString }
}
});

Index

Constructors

constructor

Properties

astNode

description

description: Maybe<string>

extensionASTNodes

extensionASTNodes: readonly InterfaceTypeExtensionNode[]

extensions

extensions: Readonly<GraphQLInterfaceTypeExtensions>

name

name: string

resolveType

resolveType: Maybe<GraphQLTypeResolver<any, any>>

Accessors

[toStringTag]

  • get [toStringTag](): string
  • Returns string

Methods

getFields

getInterfaces

toConfig

  • toConfig(): GraphQLInterfaceTypeNormalizedConfig
  • Returns GraphQLInterfaceTypeNormalizedConfig

toJSON

  • toJSON(): string
  • Returns string

toString

  • toString(): string
  • Returns string