зеркало из https://github.com/mozilla/gecko-dev.git
No bug - Fix example comments in Messaging.jsm. DONTBUILD
This commit is contained in:
Родитель
ef754ed79e
Коммит
92cdf2fa86
|
@ -34,30 +34,28 @@ let Messaging = {
|
|||
* Only one request listener can be registered for a given message.
|
||||
*
|
||||
* Example usage:
|
||||
* Messaging.addListener({
|
||||
* // aMessage is the message name.
|
||||
* // aData is data sent from Java with the request.
|
||||
* // The return value is used to respond to the request. The return
|
||||
* // type *must* be an instance of Object.
|
||||
* onRequest: function (aMessage, aData) {
|
||||
* // aData is data sent from Java with the request. The return value is
|
||||
* // used to respond to the request. The return type *must* be an instance
|
||||
* // of Object.
|
||||
* let listener = function (aData) {
|
||||
* if (aData == "foo") {
|
||||
* return { response: "bar" };
|
||||
* }
|
||||
* return {};
|
||||
* }
|
||||
* }, "Demo:Request");
|
||||
* };
|
||||
* Messaging.addListener(listener, "Demo:Request");
|
||||
*
|
||||
* The listener may also be a generator function, useful for performing a
|
||||
* task asynchronously. For example:
|
||||
* Messaging.addListener({
|
||||
* onRequest: function* (aMessage, aData) {
|
||||
* let listener = function* (aData) {
|
||||
* // Respond with "bar" after 2 seconds.
|
||||
* yield new Promise(resolve => setTimeout(resolve, 2000));
|
||||
* return { response: "bar" };
|
||||
* }
|
||||
* }, "Demo:Request");
|
||||
* };
|
||||
* Messaging.addListener(listener, "Demo:Request");
|
||||
*
|
||||
* @param aListener Listener object with an onRequest function (see example
|
||||
* usage above).
|
||||
* @param aListener Listener callback taking a single data parameter (see
|
||||
* example usage above).
|
||||
* @param aMessage Event name that this listener should observe.
|
||||
*/
|
||||
addListener: function (aListener, aMessage) {
|
||||
|
|
Загрузка…
Ссылка в новой задаче