Commit 1a145742 authored by Eduardo Sanz García's avatar Eduardo Sanz García Committed by Eduardo

Rename `callback` to `listener`

The word `listener` matches better the internal property names of
`this.channelListeners` and `this.onConnectListeners`. In addition, it
helps to differentiate from the `callback` function which is the last
(optional) argument of the `listener`. The `callback` is used to send
back a `postMessage` response to the other frame/s.
parent 6b786774
...@@ -135,18 +135,18 @@ export default class Bridge { ...@@ -135,18 +135,18 @@ export default class Bridge {
} }
/** /**
* Register a callback to be invoked when any connected channel sends a * Register a listener to be invoked when any connected channel sends a
* message to this `Bridge`. * message to this `Bridge`.
* *
* @param {string} method * @param {string} method
* @param {(...args: any[]) => void} callback -- Final argument is an optional * @param {(...args: any[]) => void} listener -- Final argument is an optional
* callback of the type: `(error: string|Error|null, ...result: any[]) => void`. * callback of the type: `(error: string|Error|null, ...result: any[]) => void`.
* This callback must be invoked in order to respond (via `postMessage`) * This callback must be invoked in order to respond (via `postMessage`)
* to the other frame/s with a result or an error. * to the other frame/s with a result or an error.
* @throws {Error} If trying to register a callback after a channel has already been created * @throws {Error} If trying to register a callback after a channel has already been created
* @throws {Error} If trying to register a callback with the same name multiple times * @throws {Error} If trying to register a callback with the same name multiple times
*/ */
on(method, callback) { on(method, listener) {
if (this.links.length > 0) { if (this.links.length > 0) {
throw new Error( throw new Error(
`Listener '${method}' can't be registered because a channel has already been created` `Listener '${method}' can't be registered because a channel has already been created`
...@@ -155,17 +155,17 @@ export default class Bridge { ...@@ -155,17 +155,17 @@ export default class Bridge {
if (this.channelListeners[method]) { if (this.channelListeners[method]) {
throw new Error(`Listener '${method}' already bound in Bridge`); throw new Error(`Listener '${method}' already bound in Bridge`);
} }
this.channelListeners[method] = callback; this.channelListeners[method] = listener;
return this; return this;
} }
/** /**
* Add a function to be called upon a new connection. * Add a listener to be called upon a new connection.
* *
* @param {(error: null, channel: RPC, window: Window) => void} callback * @param {(error: null, channel: RPC, window: Window) => void} listener
*/ */
onConnect(callback) { onConnect(listener) {
this.onConnectListeners.push(callback); this.onConnectListeners.push(listener);
return this; return this;
} }
} }
...@@ -188,7 +188,7 @@ describe('shared/bridge', () => { ...@@ -188,7 +188,7 @@ describe('shared/bridge', () => {
); );
}); });
it('only allows registering a method once', () => { it('only allows registering a listener once', () => {
bridge.on('message1', () => {}); bridge.on('message1', () => {});
let error; let error;
try { try {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment