Function: Subscription()

function Subscription(typeFn?, options?): MethodDecorator;

Defined in: packages/apollo/src/decorators/subscription.decorator.ts:81

Decorator for a GraphQL Subscription.

Parameters

Parameter	Type	Description
typeFn?	| string | (() => unknown) | SubscriptionOptions	Return type factory, options object, or subscription name.
options?	SubscriptionOptions	Subscription options when typeFn is a function.

Returns

MethodDecorator

Example

@Subscription()
async userCreated() {
  return pubSub.asyncIterator('userCreated');
}

@Subscription(() => User)
async userCreated() {
  return pubSub.asyncIterator('userCreated');
}

@Subscription('userUpdated')
async onUserUpdated() {
  return pubSub.asyncIterator('userUpdated');
}

@Subscription({
  name: 'messageAdded',
  subscribe: () => pubSub.asyncIterator('messageAdded'),
  resolve: (payload) => payload.message
})
async onMessageAdded() {}