Skip to content

Commit d71909f

Browse files
Adds section to readme
1 parent a65d812 commit d71909f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ Looking for help? Find resources [from the community](http://graphql.org/communi
1414

1515
This repo only contains the core GraphQL implementation. For a better experience when creating your GraphQL schema use [Graphiti](https://github.com/GraphQLSwift/Graphiti).
1616

17+
## Encoding Results
18+
19+
If you encode a `GraphQLResult` with an ordinary `JSONEncoder`, there are no guarantees that the field order will match the query,
20+
violating the [GraphQL spec](https://spec.graphql.org/June2018/#sec-Serialized-Map-Ordering). To preserve this order, `GraphQLResult`
21+
should be encoded using the `GraphQLJSONEncoder` provided by this package.
22+
1723
## Contributing
1824

1925
Most of this repo mirrors the structure of the canonical GraphQL implementation written in Javascript/Typescript. If there is any feature missing, looking at the original code and "translating" it to Swift works, most of the time. For example:

0 commit comments

Comments
 (0)