GraphiQL API Documentation
    Preparing search index...

    Type Alias SubscriptionClient

    The subscription-client contract the transport depends on: a single iterate(request) method returning the subscription's async iterator.

    This is intentionally the smallest shape that both graphql-ws's and graphql-sse's createClient() already satisfy, so either drops in with no wrapping. Calling .return() on the iterator must promptly stop the underlying subscription and settle any pending .next() call.

    type SubscriptionClient = {
        iterate(
            request: SubscriptionRequest,
        ): AsyncIterableIterator<
            FormattedExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
        >;
    }
    Index