@nextcloud/event-bus

A simple event bus to communicate between Nextcloud components.

Installation

npm install @nextcloud/event-bus --save
Copy

yarn add @nextcloud/event-bus
Copy

Usage

import { emit, subscribe, unsubscribe } from '@nextcloud/event-bus'

const h = e => console.info(e)

subscribe('a', h)
subscribe('b', h)

emit('a', {
    data: 123,
})

unsubscribe('a', h)
unsubscribe('b', h)
Copy

Naming convention

To stay consistent, we encourage you to use the following syntax when declaring events

app-id:object:verb

Examples:

• nextcloud:unified-search:closed
• files:file:uploading
• files:file:uploaded
• contacts:contact:deleted
• calendar:event:created
• forms:answer:updated

Development

npm install

npm run build
npm run test
Copy

Requirements

• Node 16 or higher
• NPM 8 or higher