new Receiver(name)
Initialize a new `Receiver`.
Parameters
| Name | Type | Description |
|---|---|---|
name |
String | corresponds to `Message.recipient` |
Extends
Methods
listen(thingopt)
Begin listening for inbound messages.
// When no arguments are given
// messages will be listened for
// on the default global scope
.listen();
// When an endpoint is out of reach
// BroadcastChannel can be used.
.listen(new BroadcastChannel('foo'));Parameters
| Name | Type | Attributes | Description |
|---|---|---|---|
thing |
HTMLIframeElement | Worker | MessagePort | BroadcastChannel | Window | Object |
<optional> |
unlisten()
Stop listening for inbound messages
on all endpoints listened to prior.
on(type, callback) → {this}
Add an event listener.
It is possible to subscript to * events.
Parameters
| Name | Type | Description |
|---|---|---|
type |
String | |
callback |
function |
- Inherited From:
Returns
for chaining
- Type
- this
off(typeopt, callbackopt) → {this}
Remove an event listener.
emitter.off('name', fn); // remove one callback
emitter.off('name'); // remove all callbacks for 'name'
emitter.off(); // remove all callbacksParameters
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
String |
<optional> |
|
callback |
function |
<optional> |
- Inherited From:
Returns
for chaining
- Type
- this
emit(type, dataopt) → {this}
Emit an event.
emitter.emit('name', { some: 'data' });Parameters
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
String | ||
data |
* |
<optional> |
- Inherited From:
Returns
for chaining
- Type
- this
