jQuery: JSDoc'd bind

This commit is contained in:
John Reilly
2014-02-18 16:52:02 +00:00
parent 4c2d50af48
commit 586de634a8
2 changed files with 33 additions and 3 deletions
+1 -1
View File
@@ -568,7 +568,7 @@ function test_bind() {
$("form").bind("submit", function (event) {
event.stopPropagation();
});
$("p").bind("myCustomEvent", function (e, myName, myValue) {
$("p").bind("myCustomEvent", function (e, myName?, myValue?) {
$(this).text(myName + ", hi there!");
$("span").stop().css("opacity", 1)
.text("myName = " + myName)
+32 -2
View File
@@ -2028,12 +2028,42 @@ interface JQuery {
*/
toggle(showOrHide: boolean): JQuery;
// Events
/**
* Attach a handler to an event for the elements.
*
* @param eventType A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
* @param eventData An object containing data that will be passed to the event handler.
* @param handler A function to execute each time the event is triggered.
*/
bind(eventType: string, eventData: any, handler: (eventObject: JQueryEventObject) => any): JQuery;
/**
* Attach a handler to an event for the elements.
*
* @param eventType A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
* @param handler A function to execute each time the event is triggered.
*/
bind(eventType: string, handler: (eventObject: JQueryEventObject) => any): JQuery;
/**
* Attach a handler to an event for the elements.
*
* @param eventType A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
* @param eventData An object containing data that will be passed to the event handler.
* @param preventBubble Setting the third argument to false will attach a function that prevents the default action from occurring and stops the event from bubbling. The default is true.
*/
bind(eventType: string, eventData: any, preventBubble: boolean): JQuery;
/**
* Attach a handler to an event for the elements.
*
* @param eventType A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
* @param preventBubble Setting the third argument to false will attach a function that prevents the default action from occurring and stops the event from bubbling. The default is true.
*/
bind(eventType: string, preventBubble: boolean): JQuery;
bind(...events: any[]): JQuery;
/**
* Attach a handler to an event for the elements.
*
* @param events An object containing one or more DOM event types and functions to execute for them.
*/
bind(events: any): JQuery;
blur(handler: (eventObject: JQueryEventObject) => any): JQuery;
blur(eventData?: any, handler?: (eventObject: JQueryEventObject) => any): JQuery;