Skip to content

Added structured types for higer order function parameters #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
esx wants to merge 10 commits into from
Closed

Added structured types for higer order function parameters #419

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b82bc18
Added structured types for higer order function parameters
esx Jan 18, 2014
d8093a5
Changed some argument type from XMLHttpRequest to jsXHR
esx Jan 18, 2014
0d7d9b3
Fixed spelling and changed 'ajaxOptions' to 'PlainObject'
esx Jan 18, 2014
7455ae5
Fix spelling in type attribute
esx Jan 18, 2014
d68f7ae
Changed nargument names to valid identifers to avoid confusion
esx Jan 19, 2014
41ce261
Changed argument name 'jQueryObject' to 'selection'
esx Jan 21, 2014
6aa5119
Some fixies in signatures
esx Feb 13, 2014
9d4aa93
Name fix
esx Feb 13, 2014
49a296c
Clarify jQuery.map
esx Feb 17, 2014
40db666
Signature fixes for $.each() and prop()
esx May 16, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added structured types for higer order function parameters 
Some function parameters of function type (e.g. handlers, callbacks) was
described with the signature in the name-attribute, eg. <argument
name="function(index, value)" type="Function">. This have been modified
to used nested <argument>-elements to describe the signatures more
consistently.
  • Loading branch information
@esx
esx committed Jan 18, 2014
commit b82bc1877a3bb8b6536bec0990bbeeceff45f705
5 changes: 4 additions & 1 deletion entries/addClass.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@
</signature>
<signature>
<added>1.4</added>
<argument name="function(index, currentClass)" type="Function">
<argument name="function" type="Function">
<desc>A function returning one or more space-separated class names to be added to the existing class name(s). Receives the index position of the element in the set and the existing class name(s) as arguments. Within the function, <code>this</code> refers to the current element in the set.</desc>
<argument name="index" type="Integer" />
<argument name="currentClass" type="String" />
Copy link
Member

@tjvantoll tjvantoll Jan 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use currentClassName. See http://tantek.com/2012/353/b1/why-html-classes-css-class-selectors.

<return type="String"/>
</argument>
</signature>
<desc>Adds the specified class(es) to each of the set of matched elements.</desc>
Expand Down
8 changes: 7 additions & 1 deletion entries/after.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,14 @@
</signature>
<signature>
<added>1.4</added>
<argument name="function(index)" type="Function">
<argument name="function" type="Function">
<desc>A function that returns an HTML string, DOM element(s), or jQuery object to insert after each element in the set of matched elements. Receives the index position of the element in the set as an argument. Within the function, <code>this</code> refers to the current element in the set.</desc>
<argument name="index" type="Integer" />
Copy link
Member

@tjvantoll tjvantoll Jan 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like append(), this also receives the html of the element as a second argument.

<return>
<type name="htmlString"/>
<type name="Element"/>
<type name="jQuery"/>
</return>
</argument>
</signature>
<desc>Insert content, specified by the parameter, after each element in the set of matched elements.</desc>
Expand Down
5 changes: 4 additions & 1 deletion entries/ajaxComplete.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
<title>.ajaxComplete()</title>
<signature>
<added>1.0</added>
<argument name="handler(event, XMLHttpRequest, ajaxOptions)" type="Function">
<argument name="handler" type="Function">
<argument name="event" type="Event" />
<argument name="XMLHttpRequest" type="XMLHttpRequest" />
<argument name="ajaxOptions" type="ajaxOptions" />
<desc>The function to be invoked.</desc>
</argument>
</signature>
Expand Down
6 changes: 5 additions & 1 deletion entries/ajaxError.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@
<title>.ajaxError()</title>
<signature>
<added>1.0</added>
<argument name="handler(event, jqXHR, ajaxSettings, thrownError)" type="Function">
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
<argument name="jqXHR" type="jqXHR" />
<argument name="ajaxSettings" type="ajaxSettings" />
<argument name="thrownError" type="Error" />
Copy link
Member

@tjvantoll tjvantoll Jan 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no Error object on the Types page. Also I got a String for this argument.

</argument>
</signature>
<desc>Register a handler to be called when Ajax requests complete with an error. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
Expand Down
5 changes: 4 additions & 1 deletion entries/ajaxSend.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@
<title>.ajaxSend()</title>
<signature>
<added>1.0</added>
<argument name="handler(event, jqXHR, ajaxOptions)" type="Function">
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
<argument name="jqXHR" type="jqXHR" />
<argument name="ajaxOptions" type="ajaxOptions" />
</argument>
</signature>
<desc>Attach a function to be executed before an Ajax request is sent. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
Expand Down
2 changes: 1 addition & 1 deletion entries/ajaxStart.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<title>.ajaxStart()</title>
<signature>
<added>1.0</added>
<argument name="handler()" type="Function">
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/ajaxStop.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<desc>Register a handler to be called when all Ajax requests have completed. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<signature>
<added>1.0</added>
<argument name="handler()" type="Function">
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
</argument>
</signature>
Expand Down
5 changes: 4 additions & 1 deletion entries/ajaxSuccess.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@
<title>.ajaxSuccess()</title>
<signature>
<added>1.0</added>
<argument name="handler(event, XMLHttpRequest, ajaxOptions)" type="Function">
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
<argument name="XMLHttpRequest" type="XMLHttpRequest" />
<argument name="ajaxOptions" type="ajaxOptions" />
</argument>
</signature>
<desc>Attach a function to be executed whenever an Ajax request completes successfully. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
Expand Down
9 changes: 8 additions & 1 deletion entries/append.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,15 @@
</signature>
<signature>
<added>1.4</added>
<argument name="function(index, html)" type="Function">
<argument name="function" type="Function">
<desc>A function that returns an HTML string, DOM element(s), or jQuery object to insert at the end of each element in the set of matched elements. Receives the index position of the element in the set and the old HTML value of the element as arguments. Within the function, <code>this</code> refers to the current element in the set.</desc>
<argument name="index" type="Integer" />
<argument name="html" type="String" />
<return>
<type name="htmlString"/>
<type name="Element"/>
<type name="jQuery"/>
</return>
</argument>
</signature>
<desc>Insert content, specified by the parameter, to the end of each element in the set of matched elements.</desc>
Expand Down
8 changes: 7 additions & 1 deletion entries/attr.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,14 @@ The title of the emphasis is:<div></div>
<argument name="attributeName" type="String">
<desc>The name of the attribute to set.</desc>
</argument>
<argument name="function(index, attr)" type="Function">
<argument name="function" type="Function">
<desc>A function returning the value to set. <code>this</code> is the current element. Receives the index position of the element in the set and the old attribute value as arguments.</desc>
<argument name="index" type="Integer" />
<argument name="attr" type="String" />
<return>
<type name="String"/>
<type name="Number"/>
</return>
</argument>
</signature>
<desc>Set one or more attributes for the set of matched elements.</desc>
Expand Down
6 changes: 6 additions & 0 deletions entries/before.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@
<signature>
<added>1.4</added>
<argument name="function" type="Function">
<argument name="index" type="Integer" />
Copy link
Member

@tjvantoll tjvantoll Jan 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This receives the html as a second argument.

<return>
<type name="htmlString"/>
<type name="Element"/>
<type name="jQuery"/>
</return>
<desc>A function that returns an HTML string, DOM element(s), or jQuery object to insert before each element in the set of matched elements. Receives the index position of the element in the set as an argument. Within the function, <code>this</code> refers to the current element in the set.
</desc>
</argument>
Expand Down
3 changes: 2 additions & 1 deletion entries/bind.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
Expand Down
6 changes: 4 additions & 2 deletions entries/blur.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
<desc>Bind an event handler to the "blur" JavaScript event, or trigger that event on an element.</desc>
<signature>
<added>1.0</added>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
<added>1.4.3</added>
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
Expand Down
6 changes: 4 additions & 2 deletions entries/change.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
<desc>Bind an event handler to the "change" JavaScript event, or trigger that event on an element.</desc>
<signature>
<added>1.0</added>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
<added>1.4.3</added>
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
Expand Down
6 changes: 4 additions & 2 deletions entries/click.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
<desc>Bind an event handler to the "click" JavaScript event, or trigger that event on an element.</desc>
<signature>
<added>1.0</added>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
<added>1.4.3</added>
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
Expand Down
8 changes: 7 additions & 1 deletion entries/css.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,14 @@ $( "div" ).click(function() {
<argument name="propertyName" type="String">
<desc>A CSS property name.</desc>
</argument>
<argument name="function(index, value)" type="Function">
<argument name="function" type="Function">
<desc>A function returning the value to set. <code>this</code> is the current element. Receives the index position of the element in the set and the old value as arguments.</desc>
<argument name="index" type="Integer" />
<argument name="value" type="String" />
<return>
<type name="String"/>
<type name="Number"/>
</return>
</argument>
</signature>
<signature>
Expand Down
6 changes: 4 additions & 2 deletions entries/dblclick.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
<desc>Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.</desc>
<signature>
<added>1.0</added>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
<added>1.4.3</added>
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
Expand Down
6 changes: 4 additions & 2 deletions entries/delegate.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@
<argument name="eventType" type="String">
<desc>A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," or custom event names.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute at the time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
Expand All @@ -25,8 +26,9 @@
<argument name="eventData" type="Object">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute at the time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
Expand Down
4 changes: 3 additions & 1 deletion entries/each.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
<title>.each()</title>
<signature>
<added>1.0</added>
<argument name="function(index, Element)" type="Function">
<argument name="function" type="Function">
<desc>A function to execute for each matched element.</desc>
<argument name="index" type="Integer" />
<argument name="element" type="Element" />
</argument>
</signature>
<desc>Iterate over a jQuery object, executing a function for each matched element. </desc>
Expand Down
6 changes: 4 additions & 2 deletions entries/error.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
<desc>Bind an event handler to the "error" JavaScript event.</desc>
<signature>
<added>1.0</added>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute when the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
<added>1.4.3</added>
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<longdesc>
Expand Down
4 changes: 3 additions & 1 deletion entries/filter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@
</signature>
<signature>
<added>1.0</added>
<argument name="function(index)" type="Function">
<argument name="function" type="Function">
<desc>A function used as a test for each element in the set. <code>this</code> is the current DOM element.</desc>
<argument name="index" type="Integer" />
Copy link
Member

@tjvantoll tjvantoll Jan 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The function receives the element as a second argument.

<return type="Boolean" />
</argument>
</signature>
<signature>
Expand Down
6 changes: 4 additions & 2 deletions entries/focus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
<desc>Bind an event handler to the "focus" JavaScript event, or trigger that event on an element.</desc>
<signature>
<added>1.0</added>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
<added>1.4.3</added>
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
Expand Down
6 changes: 4 additions & 2 deletions entries/focusin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
<desc>Bind an event handler to the "focusin" event.</desc>
<signature>
<added>1.4</added>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
<added>1.4.3</added>
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<longdesc>
Expand Down
6 changes: 4 additions & 2 deletions entries/focusout.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
<desc>Bind an event handler to the "focusout" JavaScript event.</desc>
<signature>
<added>1.4</added>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<signature>
<added>1.4.3</added>
<argument name="eventData" type="Object" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler(eventObject)" type="Function">
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<longdesc>
Expand Down
Loading