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

class GraphQLInterfaceType {

constructor(config: Readonly<GraphQLInterfaceTypeConfig<any, any>>);

private _fields;

private _interfaces;

astNode: Maybe<InterfaceTypeDefinitionNode>;

description: Maybe<string>;

extensionASTNodes: ReadonlyArray<InterfaceTypeExtensionNode>;

extensions: Readonly<GraphQLInterfaceTypeExtensions>;

name: string;

resolveType: Maybe<GraphQLTypeResolver<any, any>>;

get [Symbol.toStringTag](): string;

getFields(): GraphQLFieldMap<any, any>;

getInterfaces(): ReadonlyArray<GraphQLInterfaceType>;

toConfig(): GraphQLInterfaceTypeNormalizedConfig;

toJSON(): string;

toString(): string;

}

§Constructors

new GraphQLInterfaceType(config: Readonly<GraphQLInterfaceTypeConfig<any, any>>)

GraphQLInterfaceType

§Constructors

§Properties

§Methods