callbacks.disable()

Categories: Callbacks Object

callbacks.disable()Returns: Callbacks

Description: Disable a callback list from doing anything more.

This method returns the Callbacks object onto which it is attached (this).

Example:

Use callbacks.disable() to disable further calls to a callback list:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
  console.log( value );
};
 
var callbacks = $.Callbacks();
 
// Add the above function to the list
callbacks.add( foo );
 
// Fire the items on the list
callbacks.fire( "foo" );
// Outputs: foo
 
// Disable further calls being possible
callbacks.disable();
 
// Attempt to fire with "foobar" as an argument
callbacks.fire( "foobar" );
// foobar isn't output