PgPubSubOptions interface

Options accepted as option argument of PgPubSub constructor. It extends pg.ClientConfig options, mostly because it is used to construct PostgreSQL database connection, adding more properties required to configure PgPubSub objects behavior.

Signature:

export interface PgPubSubOptions extends ClientConfig

Extends: ClientConfig

Properties

Property	Type	Description
acquireInterval	number	Time interval in milliseconds before `LISTEN` clients would re-try to acquire channel locks. It works from one hand as connection keep-alive periodical pings, from other hand adds additional level of reliability for the cases when connection, which holds the lock has been suddenly disconnected in a silent manner. By default is set to `30000ms` (`30sec`). Please, assume this value should be selected for a particular system with care of often acquire lock hits and overall infrastructure reliability.
executionLock	boolean	If set to true, all instances become listeners but only instance is an executor which still implements inter-process locking mechanism.
filtered	boolean	If set to true, self emitted messages (those which were sent using `NOTIFY` on the same connection) will be filtered on this connection. By default is false - means that connection will `LISTEN` to the messages, which were notified on the same connection.
handleSignals	boolean	If set to true, the package registers SIGINT/SIGTERM/SIGABRT handlers performing graceful locks release and process exit. Default is false: a library must not take over process lifecycle unless asked to.
pgClient?	Client	(Optional) Existing PostgreSQL client connection (optional). Can be passed if there is a need to re-use existing db connection from external code. Otherwise it is required to bypass correct options to instantiate new `pg.Client` connection properly.
retryDelay	number	Specifies delay in milliseconds between re-connection retries
retryLimit	number	Specifies maximum number of re-connection retries to process, before connection would be treated as broken (disconnected). By default is set to infinite number of retries.
singleListener	boolean	Boolean flag, which turns off/on single listener mode. By default is set to true, so instantiated PgPubSub connections will act using inter-process locking mechanism.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.