Interface: SubscriptionMetadata
Defined in: packages/apollo/src/decorators/types.ts:65
Subscription
metadata.
Extends
BaseFieldMetadata
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
deprecationReason? | string | Deprecation reason. | BaseFieldMetadata.deprecationReason | packages/apollo/src/decorators/types.ts:29 |
description? | string | Description. | BaseFieldMetadata.description | packages/apollo/src/decorators/types.ts:25 |
extensions? | Record<string, unknown> | Extensions. | BaseFieldMetadata.extensions | packages/apollo/src/decorators/types.ts:33 |
kind | "subscription" | - | - | packages/apollo/src/decorators/types.ts:66 |
methodName | string | - | - | packages/apollo/src/decorators/types.ts:67 |
name? | string | Field name (defaults to method name). | BaseFieldMetadata.name | packages/apollo/src/decorators/types.ts:23 |
nullable? | boolean | Whether field is nullable. | BaseFieldMetadata.nullable | packages/apollo/src/decorators/types.ts:27 |
resolve? | ResolveFn<unknown> | Resolve function to transform payload. | - | packages/apollo/src/decorators/types.ts:71 |
returnType? | string | Constructor<unknown> | (() => unknown) | Return type. | BaseFieldMetadata.returnType | packages/apollo/src/decorators/types.ts:31 |
subscribe? | SubscribeFn<unknown> | Subscribe function (for custom pub/sub). | - | packages/apollo/src/decorators/types.ts:69 |