Comments on GraphQLFieldInput
This commit is contained in:
parent
797238ebc1
commit
3ae666aab6
1 changed files with 10 additions and 0 deletions
|
@ -1,9 +1,19 @@
|
||||||
part of graphql_schema.src.schema;
|
part of graphql_schema.src.schema;
|
||||||
|
|
||||||
|
/// An input to a GraphQL field. This is analogous to a function parameter in Dart.
|
||||||
class GraphQLFieldInput<Value, Serialized> {
|
class GraphQLFieldInput<Value, Serialized> {
|
||||||
|
/// The name of this field.
|
||||||
final String name;
|
final String name;
|
||||||
|
|
||||||
|
/// The type that input values must conform to.
|
||||||
final GraphQLType<Value, Serialized> type;
|
final GraphQLType<Value, Serialized> type;
|
||||||
|
|
||||||
|
/// An optional default value for this field.
|
||||||
final Value defaultValue;
|
final Value defaultValue;
|
||||||
|
|
||||||
|
/// An optional description for this field.
|
||||||
|
///
|
||||||
|
/// This is useful when documenting your API for consumers like GraphiQL.
|
||||||
final String description;
|
final String description;
|
||||||
|
|
||||||
/// If [defaultValue] is `null`, and `null` is a valid value for this parameter, set this to `true`.
|
/// If [defaultValue] is `null`, and `null` is a valid value for this parameter, set this to `true`.
|
||||||
|
|
Loading…
Reference in a new issue