Skip to content
This repository was archived by the owner on May 17, 2025. It is now read-only.

Latest commit

 

History

History
108 lines (62 loc) · 2.33 KB

SubscribePseudoIterable.md

File metadata and controls

108 lines (62 loc) · 2.33 KB

graphql-lambda-subscriptions / SubscribePseudoIterable

Interface: SubscribePseudoIterable<T, TSubscribeArgs>

Type parameters

Name Type
T extends PubSubEvent
TSubscribeArgs extends SubscribeArgs = SubscribeArgs

Callable

SubscribePseudoIterable

▸ SubscribePseudoIterable(...args): AsyncGenerator<T, never, unknown>

Parameters

Name Type
...args TSubscribeArgs

Returns

AsyncGenerator<T, never, unknown>

Table of contents

Properties

Properties

filter

• Optional filter: SubscriptionFilter<TSubscribeArgs, T["payload"]>

onAfterSubscribe

• Optional onAfterSubscribe: (...args: TSubscribeArgs) => MaybePromise<void>

Type declaration

▸ (...args): MaybePromise<void>

Parameters
Name Type
...args TSubscribeArgs
Returns

MaybePromise<void>

onComplete

• Optional onComplete: (...args: TSubscribeArgs) => MaybePromise<void>

Type declaration

▸ (...args): MaybePromise<void>

Parameters
Name Type
...args TSubscribeArgs
Returns

MaybePromise<void>

onSubscribe

• Optional onSubscribe: (...args: TSubscribeArgs) => MaybePromise<void | GraphQLError[]>

Type declaration

▸ (...args): MaybePromise<void | GraphQLError[]>

Parameters
Name Type
...args TSubscribeArgs
Returns

MaybePromise<void | GraphQLError[]>

topic

• topic: string