Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

fastify-pg-pubsub

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fastify-pg-pubsub

Minimal pub/sub for fastify servers with postgres

  • 1.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

fastify-pg-pubsub

Minimal pub/sub for fastify servers using postgres.

Install

fastify-pg-pubsub requires fastify-postgres.

npm install fastify-postgres fastify-pg-pubsub

Usage

The fastify-pg-pubsub plugin decorates the server instance with a pubsub property.

fastify.register(require('fastify-postgres'))
fastify.register(require('fastify-pg-pubsub'))
fastify.register(async function (server) {
  server.pubsub.on('some_channel', (message) => {
    console.log(message)
  })
  await server.pubsub.subscribe('some_channel')
  // ... elsewhere ...
  await server.pubsub.publish('some_channel', 'message')
  // ...
  await server.pubsub.unsubscribe('some_channel')
})

API

fastify.register(require('fastify-pg-pubsub'))

Register the plugin. There are no options. It will request a postgres connection from fastify-postgres.

fastify.pubsub

The pubsub property is an EventEmitter. Listen for events using the typical .on, .once methods.

fastify.pubsub.subscribe(channel)

Subscribe to a channel to start receiving messages from it. Returns a Promise that resolves when the subscription is added in postgres.

The channel name can contain a-z, 0-9, underscores, and dashes.

fastify.pubsub.unsubscribe(channel)

Unsubscribe from a channel to stop receiving messages from it. Returns a Promise that resolves when the subscription is removed in postgres.

The channel name can contain a-z, 0-9, underscores, and dashes.

fastify.pubsub.publish(channel, message)

Publish a message to a channel. You do not need to be subscribed to a channel to publish to it. The message must be a string. Use JSON.stringify or some other serialization mechanism before publishing other things.

The channel name can contain a-z, 0-9, underscores, and dashes.

License

Apache-2.0

Keywords

FAQs

Package last updated on 14 Jun 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc