README for graphql_schema

This commit is contained in:
Tobe O 2018-08-04 22:41:12 -04:00
parent 34d086fa24
commit 1f16974cb1
2 changed files with 19 additions and 1 deletions

View file

@ -7,6 +7,24 @@ The decisions made in the design of this library were done to make the experienc
as similar to the JavaScript reference implementation as possible, and to also
correctly implement the official specification.
Contains functionality to build *all* GraphQL types:
* `String`
* `Int`
* `Float`
* `Boolean`
* `GraphQLObjectType`
* `GraphQLUnionType`
* `GraphQLEnumType`
* `GraphQLInputObjectType`
* `Date` - ISO-8601 Date string, deserializes to a Dart `DateTime` object
Of course, for a full description of GraphQL's type system, see the official
specification:
http://facebook.github.io/graphql/October2016/
Mostly analogous to `graphql-js`; many names are verbatim:
https://graphql.org/graphql-js/type/
# Usage
It's easy to define a schema with the
[helper functions](#helpers):

View file

@ -1,6 +1,6 @@
part of graphql_schema.src.schema;
/// Represents the result of asserting an input [value] against a [GraphQLType].
class ValidationResult<Value> {
/// `true` if there were no errors during validation.
final bool successful;