Class PostgresPubSub

Hierarchy

PubSubEngine
- PostgresPubSub

Implements

OnModuleInit

Index

Constructors

Properties

appConfig client dataSource ee logger subscriptions

Methods

asyncIterableIterator asyncIterator isEntityRef isEntityWithId minify onModuleInit publish subscribe toRef unminify unref unsubscribe

Constructors

constructor

new PostgresPubSub(): PostgresPubSub
Returns PostgresPubSub
Overrides PubSubEngine.constructor
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:62

Properties

`Protected` `Readonly`appConfig

appConfig: AppConfigType

`Protected` `Readonly`client

client: Client

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected`ee

ee: EventEmitter<DefaultEventMap> = ...

`Protected`logger

logger: WinstonLogger

`Protected`subscriptions

subscriptions: PubSubSubscription[] = []

Methods

asyncIterableIterator

asyncIterableIterator<T>(
triggers: string | readonly string[],
): PubSubAsyncIterableIterator<T>
Type Parameters
- T
Parameters
- triggers: string | readonly string[]
Returns PubSubAsyncIterableIterator<T>
Inherited from PubSubEngine.asyncIterableIterator
- Defined in node_modules/graphql-subscriptions/dist/pubsub-engine.d.ts:6

asyncIterator

asyncIterator<T>(
triggers: string | readonly string[],
): AsyncIterator<T, any, any>
Type Parameters
- T
Parameters
- triggers: string | readonly string[]
Returns AsyncIterator<T, any, any>
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:327

`Protected`isEntityRef

isEntityRef(value: unknown): value is EntityRef
Parameters
- value: unknown
Returns value is EntityRef
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:319

`Protected`isEntityWithId

isEntityWithId(value: unknown): value is EntityWithId
Parameters
- value: unknown
Returns value is EntityWithId
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:323

`Protected`minify

minify(payload: any): any
Parameters
- payload: any
Returns any
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:190

onModuleInit

onModuleInit(): void
Returns void
Implementation of OnModuleInit.onModuleInit
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:67

publish

publish(triggerName: string, payload: any): Promise<void>
Parameters
- triggerName: string
- payload: any
Returns Promise<void>
Overrides PubSubEngine.publish
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:77

subscribe

subscribe(
triggerName: string,
callback: PubSubSubscriptionCallback,
): Promise<number>
Parameters
- triggerName: string
- callback: PubSubSubscriptionCallback
Returns Promise<number>
Overrides PubSubEngine.subscribe
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:105

`Protected`toRef

toRef(object: object): MaybeNull<EntityRef>
Parameters
- object: object
Returns MaybeNull<EntityRef>
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:175

`Protected`unminify

unminify(payload: any): Promise<any>
Parameters
- payload: any
Returns Promise<any>
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:279

`Protected`unref

unref(entityRef: EntityRef): Promise<BaseEntity | ObjectWithId>
Parameters
- entityRef: EntityRef
Returns Promise<BaseEntity | ObjectWithId>
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:230

unsubscribe

unsubscribe(subId: number): Promise<void>
Parameters
- subId: number
Returns Promise<void>
Overrides PubSubEngine.unsubscribe
- Defined in src/modules/postgres-pubsub/postgres-pubsub.ts:124