requestSubscription

import DocsRating from '@site/src/core/DocsRating'; import {OssOnly, FbInternalOnly} from 'docusaurus-plugin-internaldocs-fb/internal'; import GraphQLSubscriptionConfig from '../types/GraphQLSubscriptionConfig.md'; import Disposable from '../types/Disposable.md';

requestSubscription

Imperative API for establishing a GraphQL Subscription. See also the useSubscription API and the Guide to Updating Data.

import {graphql, requestSubscription} from 'react-relay';

const subscription = graphql`
  subscription UserDataSubscription($input: InputData!) {
    # ...
  }
`;

function createSubscription(environment: IEnvironment): Disposable {
  return requestSubscription(environment, {
    subscription,
    variables: {input: {userId: '4'}},
  });
}

Arguments

• environment: A Relay Environment
• config: GraphQLSubscriptionConfig

Return Type

• A Disposable that clears the subscription.

Behavior

• Imperatively establish a subscription.
• See the GraphQL Subscriptions Guide for a more detailed explanation of how to work with subscriptions.