From 982674c1ac82865c0dbf31ae2ec611ec1cdcd21a Mon Sep 17 00:00:00 2001
From: Hubert Argasinski <argasinski.hubert@gmail.com>
Date: Tue, 29 Mar 2016 04:09:31 -0700
Subject: jsdoc-style documentation for 'collection' methods

Converted documentation from README to jsdoc-style for respective
methods. Currently, only done for 'collection' methods.

jsdoc-style documentation - fixed 'collection' methods documentation

Only the base functions now contain an example, while the `series` and
`limit` versions simply contain a reference to the base function. Fixed
styling issue and misspelled tag.
---
 lib/reject.js | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'lib/reject.js')

diff --git a/lib/reject.js b/lib/reject.js
index 970a0ec..f7f6f10 100644
--- a/lib/reject.js
+++ b/lib/reject.js
@@ -3,4 +3,29 @@
 import rejectLimit from './rejectLimit';
 import doLimit from './internal/doLimit';
 
+/**
+ * The opposite of `filter`. Removes values that pass an `async` truth test.
+ *
+ * @name reject
+ * @static
+ * @memberOf async
+ * @see async.filter
+ * @category Collection
+ * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Function} iteratee - A truth test to apply to each item in `coll`.
+ * The `iteratee` is passed a `callback(err, truthValue)`, which must be called
+ * with a boolean argument once it has completed. Invoked with (item, callback).
+ * @param {Function} [callback] - A callback which is called after all the
+ * `iteratee` functions have finished. Invoked with (err, results).
+ * @example
+ *
+ * async.reject(['file1','file2','file3'], function(filePath, callback) {
+ *     fs.access(filePath, function(err) {
+ *         callback(null, !err)
+ *     });
+ * }, function(err, results) {
+ *     // results now equals an array of missing files
+ *     createFiles(results);
+ * });
+ */
 export default doLimit(rejectLimit, Infinity);
-- 
cgit v1.2.1