DoneJS StealJS jQuery++ FuncUnit DocumentJS
4.3.0
5.0.0 3.13.1 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-bind
      • can-compute
      • can-debug
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-backup
      • can-define-stream
      • can-define-stream-kefir
      • can-event-queue
        • ./map/
          • addEventListener
          • @can.getWhatIChange
          • @can.isBound
          • @can.offKeyValue
          • @can.onKeyValue
          • dispatch
          • listenTo
          • off
          • on
          • one
          • removeEventListener
          • stopListening
        • ./type/
        • ./value/
      • can-kefir
      • can-list
      • can-map
      • can-map-define
      • can-observation
      • can-observation-recorder
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
      • can-value
    • Data Modeling
      • can-connect
      • can-connect-feathers
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-stache
      • can-stache-bindings
      • can-stache-converters
      • can-stache-route-helpers
      • can-view-autorender
      • can-view-callbacks
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-nodelist
      • can-view-parser
      • can-view-scope
      • can-view-target
      • react-view-model
      • react-view-model/component
      • steal-stache
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-hash
      • can-route-mock
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-diff
      • can-globals
      • can-join-uris
      • can-key
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-queues
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-child-nodes
      • can-control
      • can-dom-data
      • can-dom-events
      • can-dom-mutate
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-fragment
    • Data Validation
      • can-define-validate-validatejs
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-data-types
      • can-namespace
      • can-reflect
      • can-reflect-dependencies
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

dispatch

  • Edit on GitHub

Dispatch event and key binding handlers.

obj.dispatch(event, [args])

Dispatches registered addEventListener and @can.onKeyValue value binding handlers.

The following shows dispatching the property event and keyValue handlers:

var mixinMapBindings = require("can-event-queue/map/map");

var obj = mixinMapBindings({});

obj.addEventListener("property", function(event, newVal){
  event.type //-> "property"
  newVal     //-> 5
});

canReflect.onKeyValue("property", function(newVal){
  newVal     //-> 5
})

obj.dispatch("property", [5]);

NOTE: Event handlers have an additional event argument.

Parameters

  1. event {String|Object}:

    The event to dispatch. If a string is passed, it will be used as the type of the event that will be dispatched and dispatch matching @can.onKeyValue bindings:

    obs.dispatch("key")
    

    If event is an object, it MUST have a type property. The If a string is passed, it will be used as the type of the event that will be dispatched and dispatch matching @can.onKeyValue bindings:

    obs.dispatch({type: "key"})
    

    The event object can also have the following properties and values:

    • reasonLog {Array} - The reason this event happened. This will be passed to enqueueByQueue for debugging purposes.
    • makeMeta {function} - Details about the handler being called. This will be passed to enqueueByQueue for debugging purposes.
    • patches {Array<Patch>} - The patch objects this event represents. The .patches value will be passed to the object's .constructor's @can.dispatchInstanceOnPatches method.
  2. args {Array}:

    Additional arguments to pass to event handlers.

Returns

{Object}:

event The resulting event object.

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 4.3.0.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news