dojo.connectPublisher

Project owner:Alex Russell
Available:since V0.9

Ensure that everytime an event is called, a message is published on the topic.

Introduction

dojo.connectPublisher is an automation of this common form:

dojo.connect(myObject, "myEvent", function(){
     dojo.publish("/some/topic/name", arguments);
});

Which becomes:

dojo.connectPublisher("/some/topic/name", myObject, "myEvent");

Usage

var foo = dojo.connectPublisher(topic, obj, event);

Returns a handle which can be passed to dojo.disconnect() to disable subsequent automatic publication on the topic.

Parameter Type Description
topic String The name of the topic to publish.
obj Object|null The source object for the event function. Defaults to dojo.global if null.
event String The name of the event function in obj. I.e. identifies a property obj[event].

Examples

Programmatic example

1
2
3
<script type="text/javascript">
  dojo.connectPublisher("/ajax/start", dojo, "xhrGet");
</script>
Error in the documentation? Can’t find what you are looking for? Let us know!