function MessagingPlugin
Since 0.1.0
MessagingPlugin(options?: MessagingPluginOptions): IPlugin

MessagingPlugin factory.

Creates a plugin that registers an IMessageBroker implementation based on the configured backend type. Supports multi-instance deployment via the name option.

Examples

Example 1

// Default in-memory broker
app.register(MessagingPlugin());

// GCP Pub/Sub
app.register(MessagingPlugin({
  broker: 'pubsub',
  projectId: 'my-project',
}));

// Azure Service Bus
app.register(MessagingPlugin({
  broker: 'service-bus',
  connectionString: 'Endpoint=sb://...',
}));

// Custom broker instance
app.register(MessagingPlugin({
  broker: 'custom',
  instance: myCustomBroker,
}));

Parameters

optional
options: MessagingPluginOptions

Plugin configuration options (discriminated union on broker)

Return Type

IPlugin

A configured IPlugin instance

Usage

import { MessagingPlugin } from "messaging-plugin/src/index.ts";