callbacks.fireWith.xml

<?xml version="1.0"?>
<entry name="callbacks.fireWith" type="method" return="Callbacks">
  <title>callbacks.fireWith()</title>
  <signature>
    <added>1.7</added>
    <argument name="context" optional="true">
      <desc>A reference to the context in which the callbacks in the list should be fired.</desc>
    </argument>
    <argument name="args" optional="true">
      <desc>An argument, or array of arguments, to pass to the callbacks in the list.</desc>
    </argument>
  </signature>
  <desc>Call all callbacks in a list with the given context and arguments.</desc>
  <longdesc>
    <p>This method returns the Callbacks object onto which it is attached (<code>this</code>).</p>
  </longdesc>
  <example>
    <desc>Use <code>callbacks.fireWith()</code> to fire a list of callbacks with a specific context and an array of arguments:</desc>
    <code><![CDATA[
// A sample logging function to be added to a callbacks list
var log = function( value1, value2 ) {
  console.log( "Received: " + value1 + "," + value2 );
};

var callbacks = $.Callbacks();

// Add the log method to the callbacks list
callbacks.add( log );

// Fire the callbacks on the list using the context "window"
// and an arguments array

callbacks.fireWith( window, [ "foo","bar" ] );
// Outputs: "Received: foo, bar"
]]></code>
  </example>
  <category slug="callbacks-object"/>
  <category slug="version/1.7"/>
</entry>