Interface: SubscriptionOptions
Defined in: packages/apollo/src/decorators/subscription.decorator.ts:18
Options for the
Subscription
decorator.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
deprecationReason? | string | Deprecation reason. | packages/apollo/src/decorators/subscription.decorator.ts:26 |
description? | string | Description for documentation. | packages/apollo/src/decorators/subscription.decorator.ts:22 |
extensions? | Record<string, unknown> | Additional extensions. | packages/apollo/src/decorators/subscription.decorator.ts:32 |
name? | string | Subscription name (defaults to method name). | packages/apollo/src/decorators/subscription.decorator.ts:20 |
nullable? | boolean | Whether the subscription can return null. | packages/apollo/src/decorators/subscription.decorator.ts:24 |
resolve? | ResolveFn | Resolve function to transform the payload. | packages/apollo/src/decorators/subscription.decorator.ts:30 |
returnType? | () => unknown | Return type factory function. | packages/apollo/src/decorators/subscription.decorator.ts:34 |
subscribe? | SubscribeFn | Subscribe function (async iterator). | packages/apollo/src/decorators/subscription.decorator.ts:28 |