event_broker.coffee

Jump To … +

chaplin.coffee application.coffee composer.coffee controller.coffee dispatcher.coffee composition.coffee event_broker.coffee history.coffee route.coffee router.coffee support.coffee sync_machine.coffee utils.coffee mediator.coffee collection.coffee model.coffee collection_view.coffee layout.coffee view.coffee

event_broker.coffee

'use strict'

mediator = require 'chaplin/mediator'

¶

Add functionality to subscribe and publish to global Publish/Subscribe events so they can be removed afterwards when disposing the object.

Mixin this object to add the subscriber capability to any object: .extend object, EventBroker Or to a prototype of a class: .extend @prototype, EventBroker

Since Backbone 0.9.2 this abstraction just serves the purpose that a handler cannot be registered twice for the same event.
```
EventBroker =
  subscribeEvent: (type, handler) ->
    if typeof type isnt 'string'
      throw new TypeError 'EventBroker#subscribeEvent: ' +
        'type argument must be a string'
    if typeof handler isnt 'function'
      throw new TypeError 'EventBroker#subscribeEvent: ' +
        'handler argument must be a function'
```

Ensure that a handler isn’t registered twice.

    mediator.unsubscribe type, handler, this

    mediator.subscribe type, handler, this

  unsubscribeEvent: (type, handler) ->
    if typeof type isnt 'string'
      throw new TypeError 'EventBroker#unsubscribeEvent: ' +
        'type argument must be a string'
    if typeof handler isnt 'function'
      throw new TypeError 'EventBroker#unsubscribeEvent: ' +
        'handler argument must be a function'

¶

Remove global handler.
```
    mediator.unsubscribe type, handler
```
¶

Unbind all global handlers.
```
  unsubscribeAllEvents: ->
```

Remove all handlers with a context of this subscriber.

    mediator.unsubscribe null, null, this

  publishEvent: (type, args...) ->
    if typeof type isnt 'string'
      throw new TypeError 'EventBroker#publishEvent: ' +
        'type argument must be a string'

¶

Publish global handler.
```
    mediator.publish type, args...
```
¶

You’re frozen when your heart’s not open.
```
Object.freeze? EventBroker
```
¶

Return our creation.
```
module.exports = EventBroker
```