Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ArnaudBuchholz committed Apr 29, 2017
1 parent 6e0f639 commit a2348f7
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/filter.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* @typedef gpf.typedef.filterProperty
* @property {String} property Property name to read
* @see gpf.typedef.filterItem
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -24,6 +24,7 @@
* @typedef gpf.typedef.filterEq
* @property {gpf.typedef.filterItem[]} eq List of items to compare,
* returns true if all values are strictly equal
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -33,6 +34,7 @@
* @typedef gpf.typedef.filterNe
* @property {gpf.typedef.filterItem[]} eq List of items to compare,
* returns true if all values are strictly different
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -41,6 +43,7 @@
*
* @typedef gpf.typedef.filterLt
* @property {gpf.typedef.filterItem[]} lt List of items to compare
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -49,6 +52,7 @@
*
* @typedef gpf.typedef.filterLte
* @property {gpf.typedef.filterItem[]} lte List of items to compare
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -57,6 +61,7 @@
*
* @typedef gpf.typedef.filterGt
* @property {gpf.typedef.filterItem[]} gt List of items to compare
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -65,6 +70,7 @@
*
* @typedef gpf.typedef.filterGte
* @property {gpf.typedef.filterItem[]} gte List of items to compare
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -74,6 +80,7 @@
* @typedef gpf.typedef.filterNot
* @property {gpf.typedef.filterItem} not Item to negate,
* returns true if the item is falsy, false otherwise
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -85,6 +92,7 @@
* @property {String} regexp Regular expression specification
* @property {Number} [group] If the regular expression contains capturing group, this members can be used to return
* the group by index (1-based)
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -94,6 +102,7 @@
* @typedef gpf.typedef.filterOr
* @property {gpf.typedef.filterItem[]} or List of items to or,
* returns the first truthy value or the last falsy value
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -103,6 +112,7 @@
* @typedef gpf.typedef.filterAnd
* @property {gpf.typedef.filterItem[]} and List of items to and,
* returns the first falsy value or the last truthy value
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand All @@ -122,6 +132,7 @@
* | gpf.typedef.filterOr
* | gpf.typedef.filterAnd
* } gpf.typedef.filterItem
* @see gpf.createFilterFunction
* @since 0.1.9
*/

Expand Down

0 comments on commit a2348f7

Please sign in to comment.