GraphQLInterfaceType <TSource, TContext>

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 }
  }
});

Implements

• GraphQLSchemaElement

Index

Constructors

• constructor

Properties

• astNode
• description
• extensionASTNodes
• extensions
• name
• resolveType

Accessors

• [toStringTag]

Methods

• getFields
• getInterfaces
• toConfig
• toJSON
• toString

Constructors

constructor

• new GraphQLInterfaceType<TSource, TContext>(config: Readonly<GraphQLInterfaceTypeConfig<TSource, TContext>>): GraphQLInterfaceType<TSource, TContext>

• Type parameters

  • TSource = any
  • TContext = any

  Parameters

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

  Returns GraphQLInterfaceType<TSource, TContext>

Properties

astNode

astNode: Maybe<InterfaceTypeDefinitionNode>

description

description: Maybe<string>

extensionASTNodes

extensionASTNodes: readonly InterfaceTypeExtensionNode[]

extensions

extensions: Readonly<GraphQLInterfaceTypeExtensions>

name

name: string

resolveType

resolveType: Maybe<GraphQLTypeResolver<TSource, TContext>>

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(): GraphQLInterfaceTypeNormalizedConfig<TSource, TContext>

• Returns GraphQLInterfaceTypeNormalizedConfig<TSource, TContext>

toJSON

• toJSON(): string

• Implementation of GraphQLSchemaElement.toJSON

  Returns string

toString

• toString(): string

• Implementation of GraphQLSchemaElement.toString

  Returns string