TypeInfo

TypeInfo is a utility class which, given a GraphQL schema, can keep track of the current field and type definitions at any point in a GraphQL document AST during a recursive descent by calling enter(node) and leave(node).

Index

Constructors

• constructor

Accessors

• [toStringTag]

Methods

• enter
• getArgument
• getDefaultValue
• getDirective
• getEnumValue
• getFieldDef
• getFragmentArgument
• getFragmentSignature
• getFragmentSignatureByName
• getInputType
• getParentInputType
• getParentType
• getType
• leave

Constructors

constructor

• new TypeInfo(schema: GraphQLSchema, initialType?: Maybe<GraphQLType>, getFieldDefFn?: Maybe<GetFieldDefFn>, fragmentSignatures?: Maybe<(fragmentName: string) => Maybe<FragmentSignature>>): TypeInfo

• Parameters

  • schema: GraphQLSchema

  • optionalinitialType: Maybe<GraphQLType>

    Initial type may be provided in rare cases to facilitate traversals beginning somewhere other than documents.

  • optionalgetFieldDefFn: Maybe<GetFieldDefFn>

    @deprecated

    will be removed in 17.0.0

  • optionalfragmentSignatures: Maybe<(fragmentName: string) => Maybe<FragmentSignature>>

  Returns TypeInfo

Accessors

[toStringTag]

• get [toStringTag](): string

• Returns string

Methods

enter

• enter(node: ASTNode): void

• Parameters

  • node: ASTNode

  Returns void

getArgument

• getArgument(): Maybe<GraphQLArgument>

• Returns Maybe<GraphQLArgument>

getDefaultValue

• getDefaultValue(): unknown

• Returns unknown

getDirective

• getDirective(): Maybe<GraphQLDirective>

• Returns Maybe<GraphQLDirective>

getEnumValue

• getEnumValue(): Maybe<GraphQLEnumValue>

• Returns Maybe<GraphQLEnumValue>

getFieldDef

• getFieldDef(): Maybe<GraphQLField<unknown, unknown, any>>

• Returns Maybe<GraphQLField<unknown, unknown, any>>

getFragmentArgument

• getFragmentArgument(): Maybe<VariableDefinitionNode>

• Returns Maybe<VariableDefinitionNode>

getFragmentSignature

• getFragmentSignature(): Maybe<FragmentSignature>

• Returns Maybe<FragmentSignature>

getFragmentSignatureByName

• getFragmentSignatureByName(): (fragmentName: string) => Maybe<FragmentSignature>

• Returns (fragmentName: string) => Maybe<FragmentSignature>

  • • (fragmentName: string): Maybe<FragmentSignature>

    • Parameters

      • fragmentName: string

      Returns Maybe<FragmentSignature>

getInputType

• getInputType(): Maybe<GraphQLInputType>

• Returns Maybe<GraphQLInputType>

getParentInputType

• getParentInputType(): Maybe<GraphQLInputType>

• Returns Maybe<GraphQLInputType>

getParentType

• getParentType(): Maybe<GraphQLCompositeType>

• Returns Maybe<GraphQLCompositeType>

getType

• getType(): Maybe<GraphQLOutputType>

• Returns Maybe<GraphQLOutputType>

leave

• leave(node: ASTNode): void

• Parameters

  • node: ASTNode

  Returns void