Documentation

InterfaceType extends TypeWithFields

in package

• Application

implements AbstractType, OutputType, CompositeType, NullableType, NamedType, ImplementingType

Registry of standard GraphQL types and a base class for all other types.

Interfaces, Classes, Traits and Enums

AbstractType

export type AbstractType = InterfaceType | UnionType;

OutputType

CompositeType

NullableType

NamedType

export type NamedType = | ScalarType | ObjectType | InterfaceType | UnionType | EnumType | InputObjectType;

ImplementingType

export type GraphQLImplementingType = GraphQLObjectType | GraphQLInterfaceType;

Table of Contents

BOOLEAN  = 'Boolean'

FLOAT  = 'Float'

ID  = 'ID'

INT  = 'Int'

STRING  = 'String'

$astNode  : InterfaceTypeDefinitionNode|null

$config  : array<string|int, mixed>

$description  : string|null

$extensionASTNodes  : array<int, InterfaceTypeExtensionNode>

$name  : string

$standardTypes  : array<string, ScalarType>

$builtInTypes  : array<string|int, Type>

$fields  : array<string, FieldDefinition>

Lazily initialized.

$interfaceMap  : array<string, InterfaceType>

Lazily initialized.

$interfaces  : array<int, InterfaceType>

Lazily initialized.

__construct()  : mixed

__toString()  : string

assertInterfaceType()  : $this

assertType()  : Type

assertValid()  : void

boolean()  : ScalarType

findField()  : FieldDefinition|null

float()  : ScalarType

getAllBuiltInTypes()  : array<string|int, Type>

Returns all builtin in types including base scalar and introspection types

getField()  : FieldDefinition

getFieldNames()  : array<int, string>

getFields()  : array<string, FieldDefinition>

getInterfaces()  : array<int, InterfaceType>

getInternalTypes()  : array<string|int, Type>

getNamedType()  : Type|null

getNullableType()  : Type

getStandardTypes()  : array<string|int, ScalarType>

Returns all builtin scalar types

hasField()  : bool

id()  : ScalarType

implementsInterface()  : bool

int()  : ScalarType

isAbstractType()  : bool

isBuiltInType()  : bool

Checks if the type is a builtin type

isCompositeType()  : bool

isInputType()  : bool

isLeafType()  : bool

isOutputType()  : bool

jsonSerialize()  : string

listOf()  : ListOfType

nonNull()  : NonNull

overrideStandardTypes()  : mixed

resolveType()  : Type|null

Resolves concrete ObjectType for given object value

string()  : ScalarType

toString()  : string

tryInferName()  : string|null

initializeFields()  : void