From 34d086fa24d8603d1fb0e5e149657d3b026ed03e Mon Sep 17 00:00:00 2001 From: Tobe O Date: Sat, 4 Aug 2018 22:38:11 -0400 Subject: [PATCH] Validation result docs --- graphql_schema/lib/src/validation_result.dart | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/graphql_schema/lib/src/validation_result.dart b/graphql_schema/lib/src/validation_result.dart index 67b787ff..175b2532 100644 --- a/graphql_schema/lib/src/validation_result.dart +++ b/graphql_schema/lib/src/validation_result.dart @@ -1,8 +1,14 @@ part of graphql_schema.src.schema; -class ValidationResult { +/// Represents the result of asserting an input [value] against a [GraphQLType]. +class ValidationResult { + /// `true` if there were no errors during validation. final bool successful; - final T value; + + /// The input value passed to whatever caller invoked validation. + final Value value; + + /// A list of errors that caused validation to fail. final List errors; ValidationResult._(this.successful, this.value, this.errors);