Skip to content
This repository has been archived by the owner on Mar 20, 2023. It is now read-only.

Add instuctions for using experimental features #727

Merged
merged 1 commit into from Nov 23, 2020
Merged

Add instuctions for using experimental features #727

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -362,6 +362,17 @@ customFormatErrorFn: (error) => ({
});
```

## Experimental features

Each release of `express-graphql` will be accompanied by an experimental release containing support for the `@defer` and `@stream` directive proposal. We are hoping to get community feedback on these releases before the proposal is accepted into the GraphQL specification. You can use this experimental release of `express-graphql` by adding the following to your project's `package.json` file.

```
"express-graphql": "experimental-stream-defer",
"graphql": "experimental-stream-defer"
```

Community feedback on this experimental release is much appreciated and can be provided on the [PR for the defer-stream branch](https://github.com/graphql/express-graphql/pull/726) or the [GraphQL.js issue for feedback](https://github.com/graphql/graphql-js/issues/2848).

[`graphql.js`]: https://github.com/graphql/graphql-js
[`formaterror`]: https://github.com/graphql/graphql-js/blob/master/src/error/formatError.js
[graphiql]: https://github.com/graphql/graphiql
Expand Down