Postgres pubsub client
npm install pg-notify> Postgres PubSub client using NOTIFY/LISTEN
``sh`
npm install pg-notify`sh`
yarn add pg-notify
`sh`
pnpm add pg-notify
> PGPubSub accepts the same config as pg.
`js
import PGPubSub from 'pg-notify'
//const PGPubSub = require('pg-notify')
;(async () => {
const pubsub = new PGPubSub({
connectionString: 'postgres://postgres:postgres@localhost:5432/db'
})
await pubsub.connect()
await pubsub.on('test', (payload) => {
console.log('payload: ', payload)
})
await pubsub.emit('test', 'this is the payload')
await pubsub.emit('test', { foo: 'bar' })
await pubsub.close()
})()
`
(object) Configuration options for pg-notify pubsub instance. Accepts same options as pg with few custom ones described below.
- reconnectMaxRetries (number) Maximum number of reconnect attempts after losing connection. Pass 0 to disable reconnecting. Default: 10.
- maxPayloadSize (number) Maximum payload size, exceeding given size will throw an error. Default: 7999 (In the default configuration it must be shorter than 8000 bytes.).$3
- channel (string)
- payload (string or object)$3
- channel (string)
- listener (function accepting single argument payload)$3
- listener (function accepting single argument payload`)Contributions, issues and feature requests are welcome!
Copyright © 2020 Aldis Ameriks.
This project is MIT licensed.