apollo-elements/apollo-elements

View on GitHub
docs/type-tables/SubscriptionHybridsFactoryOptions.md

Summary

Maintainability
Test Coverage
| Option                 | Description                                                    |                                                                                                                                             |
| ---------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| client                 | `ApolloClient`{lang=ts}                                        | ApolloClient instance for the subscription.                                                                                                 |
| fetchPolicy            | `FetchPolicy`{lang=ts}                                         | See [fetchPolicy](/api/core/interfaces/subscription/#fetchpolicy)                                                                           |
| noAutoSubscribe        | `boolean`{lang=ts}                                             | If set, the component will not subscribe until called explicitly. See [noAutoSubscribe](/api/core/interfaces/subscription/#noautosubscribe) |
| onError                | `(error: ApolloError) => void`{lang=ts}                        | Callback for when subscription produces an error                                                                                            |
| onData                 | `(result: OnSubscriptionDataParams<Data<D>>) => void`{lang=ts} | Callback for when subscription produces new data. See [onSubscriptionData](/api/core/interfaces/subscription/#onsubscriptiondata)           |
| onSubscriptionComplete | `() => void`{lang=ts}                                          | Callback that fires when the subscription ends. See [onSubscriptionComplete](/api/core/interfaces/subscription/#onsubscriptioncomplete)     |
| shouldResubscribe      | `boolean`{lang=ts}                                             | Determines if your subscription should be unsubscribed and subscribed again                                                                 |
| shouldSubscribe        | `(op?: Partial<Operation<D, V>>) => boolean`{lang=ts}          | Predicate which determines whether to automatically subscribe. See [shouldSubscribe](/api/core/interfaces/subscription/#shouldsubscribe)    |
| skip                   | `boolean`{lang=ts}                                             | When true, the subscription will not fetch at all.                                                                                          |
| subscription           | `DocumentNode`{lang=ts}                                        | Subscription GraphQL Document                                                                                                               |
| variables              | `Variables<D, V>`{lang=ts}                                     | Subscription variables                                                                                                                      |