• PgChannelEmitter
• PgIpLock
• PgPubSub

• AnyLogger
• JsonArray
• JsonMap
• PgClient
• PgPubSubOptions

• AnyJson
• AnyListener
• ChannelListener
• ChannelsListener
• ErrorListener
• MessageListener
• ReconnectListener
• VoidListener

• ACQUIRE_INTERVAL
• IS_ONE_PROCESS
• RETRY_DELAY
• RETRY_LIMIT
• RX_LOCK_CHANNEL
• SCHEMA_NAME
• SHUTDOWN_TIMEOUT
• timer

• pack
• printChannels
• terminate
• unpack

• DefaultOptions

Ƭ AnyJson: boolean | number | string | null | JsonArray | JsonMap

Defined in src/types/AnyJson.ts:19

Represents any JSON-serializable value

---

Ƭ AnyListener: function

Defined in src/types/Listeners.ts:67

Any listener is untyped listener which may accept any number of arguments

param optional arguments, any number

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

---

Ƭ ChannelListener: function

Defined in src/types/Listeners.ts:60

Channel event listener, where an event is a channel name, and payload is accepted as an event data

param payload published to a channel

▸ (payload: AnyJson): void

Parameters:

Name	Type
payload	AnyJson

---

Ƭ ChannelsListener: function

Defined in src/types/Listeners.ts:52

Usually occurred within UNLISTEN calls or other cases, accepting list of channel names it happened on

param list of channel names

▸ (channels: string[]): void

Parameters:

Name	Type
channels	string[]

---

Ƭ ErrorListener: function

Defined in src/types/Listeners.ts:35

Error listener, accepts any kind of Error as an argument

param error occurred with error event

▸ (err: Error): void

Parameters:

Name	Type
err	Error

---

Ƭ MessageListener: function

Defined in src/types/Listeners.ts:44

Notification message event listener, accepts channel and massage payload as arguments

param channel name on which event occurred

param payload data coming from an event

▸ (channel: string, payload: AnyJson): void

Parameters:

Name	Type
channel	string
payload	AnyJson

---

Ƭ ReconnectListener: function

Defined in src/types/Listeners.ts:28

Reconnection event listener, accepts retries number as an argument

param number of retries made before reconnect succeeds

▸ (retries: number): void

Parameters:

Name	Type
retries	number

---

Ƭ VoidListener: function

Defined in src/types/Listeners.ts:21

Listener with no arguments and no return values

▸ (): void

• ACQUIRE_INTERVAL: 30000 = 30000

Defined in src/constants.ts:21

---

• IS_ONE_PROCESS: true = true

Defined in src/constants.ts:20

---

• RETRY_DELAY: 100 = 100

Defined in src/constants.ts:18

---

• RETRY_LIMIT: number = Infinity

Defined in src/constants.ts:19

---

• RX_LOCK_CHANNEL: RegExp = new RegExp(^__${PgIpLock.name}__:)

Defined in src/PgIpLock.ts:339

---

• SCHEMA_NAME: "pgip_lock" = "pgip_lock"

Defined in src/constants.ts:16

---

• SHUTDOWN_TIMEOUT: 500 = 500

Defined in src/constants.ts:17

---

• timer: any

Defined in src/PgIpLock.ts:341

▸ pack(input: AnyJson, logger?: AnyLogger, pretty: boolean): string

Defined in src/helpers.ts:27

Serializes given input object to JSON string. On error will return serialized null value

Parameters:

Name	Type	Default	Description
input	AnyJson	-	serializable object
logger?	AnyLogger	-	-
pretty	boolean	false	-

Returns: string

---

▸ printChannels(pubSub: PgPubSub): void

Defined in debug.ts:3

Parameters:

Name	Type
pubSub	PgPubSub

Returns: void

---

▸ terminate(): Promise‹void›

Defined in src/PgIpLock.ts:346

Performs graceful shutdown of running process releasing all instantiated locks and properly destroy all their instances.

Returns: Promise‹void›

---

▸ unpack(input?: undefined | string, logger?: AnyLogger): AnyJson

Defined in src/helpers.ts:57

Deserializes given input JSON string to corresponding JSON value object. On error will return empty object

Parameters:

Name	Type	Description
input?	undefined | string	string to deserialize
logger?	AnyLogger	-

Returns: AnyJson

Defined in src/types/PgPubSubOptions.ts:87

Hard-coded pre-set of PgPubSubOptions

see PgPubSubOptions

type {PgPubSubOptions}

• acquireInterval: number = ACQUIRE_INTERVAL

Defined in src/types/PgPubSubOptions.ts:91

• retryDelay: number = RETRY_DELAY

Defined in src/types/PgPubSubOptions.ts:89

• retryLimit: number = RETRY_LIMIT

Defined in src/types/PgPubSubOptions.ts:88

• singleListener: true = IS_ONE_PROCESS

Defined in src/types/PgPubSubOptions.ts:90