Skip to content

Commit 3e89df9

Browse files
committed
document result
1 parent 26dd237 commit 3e89df9

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,12 @@ The type generation process is recursive, traveling down through any nested `Inp
6666
| `msg` | `string` | A plain, natural language description of the error. |
6767
| `suberrors` | `<field-name>_Suberrors` | If your field has a complex type (eg. `InputObjectType` or `ListOfType`), then a `suberrors` field will be added with its own custom, generated type. |
6868

69-
The top-level `<field-name>ResultType` will have an additional field:
69+
The top-level `<field-name>ResultType` will have a few additional fields:
7070

7171
| Field | Type | Description |
7272
|-------------|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
7373
| `valid` | `bool` | Resolves to `true` if all `args` and nested `fields` pass validation, `false` if not. |
74+
| `result` | `mixed` | This is the original `type` you provided when declaring your field. Eg, If you specified `type` to be a `Book`, then the type of `result` will be `Book`. |
7475

7576
You can then simply query for these fields along with `result`:
7677
```graphql

0 commit comments

Comments
 (0)