Import members from @edx/frontend-platform
The PubSub module is a thin wrapper around the base functionality of PubSubJS. For the sake of simplicity and not relying too heavily on implementation-specific features, it maintains a fairly simple API (subscribe, unsubscribe, and publish).
Publish/Subscribe events should be used mindfully, especially in relation to application UI frameworks like React. Given React's unidirectional data flow and prop/state management capabilities, using a pub/sub mechanism is at odds with that framework's best practices.
That said, we use pub/sub in our application initialization sequence to allow applications to hook into the initialization lifecycle, and we also use them to publish when the application state has changed, i.e., when the config document or user's authentication state have changed.
Methods
(inner) publish(type, data)
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | |
data |
Object |
(inner) subscribe(type, callback) → {string}
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | |
callback |
function |
Returns:
A subscription token that can be passed to unsubscribe
- Type
- string
(inner) unsubscribe(token)
Parameters:
| Name | Type | Description |
|---|---|---|
token |
string | A subscription token provided by |