ext-message-broker

Easier communication for chrome extensions, while also allowing finer controls like frame-based communciation and namespacing.

Setup

$3

Install the dependency
``
npm install ext-message-broker
`

You must create a message broker in your background script.
`ts
import { MessageBroker } from 'ext-message-broker'

const broker = new MessageBroker()
`

$3


`ts
import { WebBroker } from 'ext-message-broker'

const broker = new WebBroker({
allowExternal: false // set to true if you want to allow access from an external site
})
`

$3


`ts
import { WebBroker } from 'ext-message-broker'

const broker = new WebBroker({
extensionId: 'your browser extension id', // this is required
})
`
If your site is externally accessible, you can connect directly from the site:
`ts
import { WebBroker } from 'ext-message-broker'

const broker = new WebBroker({
extensionId: 'your browser extension id', // this is required
mode: 'direct',
})
`

Usage

$3


`ts
import { MessageBroker } from 'ext-message-broker'

const broker = new MessageBroker()

broker.on('hello-world', (e) => {
console.log(e.data)

e.reply('hello-there', { name: 'general-kenobi' })
})

broker.send('test', { data: 123 })
`


$3


`ts
import { WebBroker } from 'ext-message-broker'

const broker = new WebBroker()

broker.on('hello-there', (e) => {
console.log(e.data)
})

broker.broadcast('hello-world', { name: 'general-grievous' }) // broadcasts to all connected brokers (except ones in current frame, aka the broker it came from to prevent echo - note: this WILL echo when usePort is disabled)

broker.sendToParent('hello', 123) // sends to the frame's parent

broker.sendToHost('hello', 123)
// sendToHost is an equivalent of this:
broker.sendToTarget('hello', 123, {
tabId: 1234, // put a tab id here
frameId: 0, // top most frame
})

broker.sendToBackground('hello', 123) // sends to the background message broker
broker.send('hello', 123) // sends to background by default
``