GraphQLInputObjectType

Input Object Type Definition

An input object defines a structured collection of fields which may be supplied to a field argument.

Using NonNull will ensure that a value must be provided by the query

Example:

const GeoPoint = new GraphQLInputObjectType({
  name: 'GeoPoint',
  fields: {
    lat: { type: new GraphQLNonNull(GraphQLFloat) },
    lon: { type: new GraphQLNonNull(GraphQLFloat) },
    alt: { type: GraphQLFloat, defaultValue: 0 },
  }
});

Index

Constructors

• constructor

Properties

• astNode
• description
• extensionASTNodes
• extensions
• isOneOf
• name

Accessors

• [toStringTag]

Methods

• getFields
• toConfig
• toJSON
• toString

Constructors

constructor

• new GraphQLInputObjectType(config: Readonly<GraphQLInputObjectTypeConfig>): GraphQLInputObjectType

• Parameters

  • config: Readonly<GraphQLInputObjectTypeConfig>

  Returns GraphQLInputObjectType

Properties

astNode

astNode: Maybe<InputObjectTypeDefinitionNode>

description

description: Maybe<string>

extensionASTNodes

extensionASTNodes: readonly InputObjectTypeExtensionNode[]

extensions

extensions: Readonly<GraphQLInputObjectTypeExtensions>

isOneOf

isOneOf: boolean

name

name: string

Accessors

[toStringTag]

• get [toStringTag](): string

• Returns string

Methods

getFields

• getFields(): GraphQLInputFieldMap

• Returns GraphQLInputFieldMap

toConfig

• toConfig(): GraphQLInputObjectTypeNormalizedConfig

• Returns GraphQLInputObjectTypeNormalizedConfig

toJSON

• toJSON(): string

• Returns string

toString

• toString(): string

• Returns string