Skip to main content

stream

The @stream directive may be provided for a field of List type so that the backend can leverage technology such as asynchronous iterators to provide a partial list in the initial response, and additional list items in subsequent responses. @include and @skip take precedence over @stream.

directive @stream(
  label: String
  initialCount: Int! = 0
  if: Boolean
) on FIELD

Arguments​

stream.label ● String scalar​

If this argument label has a value other than null, it will be passed on to the result of this stream directive. This label is intended to give client applications a way to identify to which fragment a streamed result belongs to.

stream.initialCount ● Int! non-null scalar​

The initial elements that shall be send down to the consumer.

stream.if ● Boolean scalar​

Streamed when true.