GraphQLFieldInput<Value, Serialized> class
An input to a GraphQL field. This is analogous to a function parameter in Dart.
- Implemented types
- Annotations
-
- @immutable
Constructors
-
GraphQLFieldInput(String name, GraphQLType<
Value, Serialized> type, {Value? defaultValue, String? description, String? deprecationReason, bool defaultsToNull = false, GraphQLAttachments attachments = const [], InputValueDefinitionNode? astNode}) - An input to a GraphQL field. This is analogous to a function parameter in Dart.
Properties
- astNode → InputValueDefinitionNode?
-
If this was parsed from an ast, the node in that ast
final
- attachments → GraphQLAttachments
-
Other custom values that may modify the execution, validation or
introspection for this element
final
- defaultsToNull → bool
-
If defaultValue is
null
, andnull
is a valid value for this parameter's type, set this totrue
if you want fornull
to be the default value.final - defaultValue → Value?
-
An optional default value for this field.
final
- deprecationReason → String?
-
If this input is deprecated, this would be the deprecation reason.
final
- description → String?
-
An optional description for this field.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isRequired → bool
-
Returns true if this type input is non-nullable and
doesn't have a default value
no setter
- name → String
-
The name of this field.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
type
→ GraphQLType<
Value, Serialized> -
The type that input values must conform to.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
validateDefaultSerialization(
SerdeCtx serdeCtx, GraphQLFieldInput field) → void - Throws an exception if the default value cannot be deserialized