@stdlib/utils-async-some-by-right 0.0.8 → 0.2.0

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/validate.js", "../lib/limit.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;\nvar isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @param {boolean} [options.series] - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n*     'thisArg': {},\n*     'series': false,\n*     'limit': 10\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n*     throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'thisArg' ) ) {\n\t\topts.thisArg = options.thisArg;\n\t}\n\tif ( hasOwnProp( options, 'series' ) ) {\n\t\topts.series = options.series;\n\t\tif ( !isBoolean( opts.series ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'series', opts.series ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'limit' ) ) {\n\t\topts.limit = options.limit;\n\t\tif ( !isPositiveInteger( opts.limit ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a positive integer. Option: `%s`.', 'limit', opts.limit ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar logger = require( 'debug' );\n\n\n// VARIABLES //\n\nvar debug = logger( 'some-by-right-async:limit' );\n\n\n// MAIN //\n\n/**\n* Invokes a predicate function once for each element in a collection, limiting the number of concurrently pending functions and iterating from right to left.\n*\n* @private\n* @param {Collection} collection - input collection\n* @param {PositiveInteger} n - number of elements\n* @param {Options} opts - function options\n* @param {*} [opts.thisArg] - execution context\n* @param {PositiveInteger} [opts.limit] - maximum number of pending function invocations\n* @param {Function} predicate - predicate function\n* @param {Callback} done - function to invoke upon completion or upon encountering an error\n* @returns {void}\n*/\nfunction limit( collection, n, opts, predicate, done ) {\n\tvar count;\n\tvar flg;\n\tvar lim;\n\tvar len;\n\tvar idx;\n\tvar cnt;\n\tvar i;\n\n\tlen = collection.length;\n\tdebug( 'Collection length: %d', len );\n\n\tif ( len === 0 ) {\n\t\tdebug( 'Finished processing a collection.' );\n\t\treturn done( null, false );\n\t}\n\tif ( len < opts.limit ) {\n\t\tlim = len;\n\t} else {\n\t\tlim = opts.limit;\n\t}\n\tdebug( 'Concurrency limit: %d', lim );\n\tdebug( 'Number of arguments: %d', predicate.length );\n\n\tcount = 0; // processed element count\n\tidx = len;\n\tcnt = 0; // success count\n\tfor ( i = 0; i < lim; i++ ) {\n\t\t// This guard is necessary to protect against synchronous functions which exhaust all collection elements...\n\t\tif ( idx > 0 ) {\n\t\t\tnext(); // eslint-disable-line node/callback-return\n\t\t}\n\t}\n\n\t/**\n\t* Callback to invoke a provided function for the next element in a collection.\n\t*\n\t* @private\n\t*/\n\tfunction next() {\n\t\tidx -= 1;\n\t\tdebug( 'Collection element %d: %s.', idx, JSON.stringify( collection[ idx ] ) );\n\t\tif ( predicate.length === 2 ) {\n\t\t\tpredicate.call( opts.thisArg, collection[ idx ], clbk );\n\t\t} else if ( predicate.length === 3 ) {\n\t\t\tpredicate.call( opts.thisArg, collection[ idx ], idx, clbk );\n\t\t} else {\n\t\t\tpredicate.call( opts.thisArg, collection[ idx ], idx, collection, clbk ); // eslint-disable-line max-len\n\t\t}\n\t}\n\n\t/**\n\t* Callback invoked once a provided function finishes processing a collection element.\n\t*\n\t* @private\n\t* @param {*} [error] - error\n\t* @param {*} [result] - test result\n\t* @returns {void}\n\t*/\n\tfunction clbk( error, result ) {\n\t\tif ( flg ) {\n\t\t\t// Prevent further processing of collection elements:\n\t\t\treturn;\n\t\t}\n\t\tif ( error ) {\n\t\t\tflg = true;\n\t\t\tdebug( 'Encountered an error: %s', error.message );\n\t\t\treturn done( error );\n\t\t}\n\t\tcount += 1;\n\t\tdebug( 'Processed %d of %d collection elements.', count, len );\n\n\t\tdebug( 'Test result: %s', !!result );\n\t\tif ( result && !flg ) {\n\t\t\tcnt += 1;\n\t\t\tif ( cnt === n ) {\n\t\t\t\tflg = true;\n\t\t\t\tdebug( 'Finished processing a collection.' );\n\t\t\t\treturn done( null, true );\n\t\t\t}\n\t\t}\n\t\tif ( idx > 0 ) {\n\t\t\treturn next();\n\t\t}\n\t\tif ( count === len ) {\n\t\t\tdebug( 'Finished processing a collection.' );\n\t\t\treturn done( null, false );\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = limit;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar format = require( '@stdlib/string-format' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\nvar validate = require( './validate.js' );\nvar limit = require( './limit.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for testing whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.\n*\n* ## Notes\n*\n* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.\n* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).\n*\n* @param {Options} [options] - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @param {boolean} [options.series=false] - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection\n* @param {Function} predicate - predicate function to invoke for each element in a collection\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {TypeError} last argument must be a function\n* @returns {Function} function which invokes the predicate function once for each element in a collection\n*\n* @example\n* var readFile = require( '@stdlib/fs-read-file' );\n*\n* function predicate( file, next ) {\n*     var opts = {\n*         'encoding': 'utf8'\n*     };\n*     readFile( file, opts, onFile );\n*\n*     function onFile( error ) {\n*         if ( error ) {\n*             return next( null, false );\n*         }\n*         next( null, true );\n*     }\n* }\n*\n* var opts = {\n*     'series': true\n* };\n*\n* // Create a `someByRightAsync` function which invokes the predicate function for each collection element sequentially:\n* var someByRightAsync = factory( opts, predicate );\n*\n* // Create a collection over which to iterate:\n* var files = [\n*     './beep.js',\n*     './boop.js'\n* ];\n*\n* // Define a callback which handles results:\n* function done( error, bool ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     if ( bool ) {\n*         console.log( 'Successfully read some files.' );\n*     } else {\n*         console.log( 'Unable to read some files.' );\n*     }\n* }\n*\n* // Try to read each element in `files`:\n* someByRightAsync( files, 2, done );\n*/\nfunction factory( options, predicate ) {\n\tvar opts;\n\tvar err;\n\tvar f;\n\n\topts = {};\n\tif ( arguments.length > 1 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tf = predicate;\n\t} else {\n\t\tf = options;\n\t}\n\tif ( !isFunction( f ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', f ) );\n\t}\n\tif ( opts.series ) {\n\t\topts.limit = 1;\n\t} else if ( !opts.limit ) {\n\t\topts.limit = PINF;\n\t}\n\treturn someByRightAsync;\n\n\t/**\n\t* Invokes a predicate function for each element in a collection, iterating from right to left.\n\t*\n\t* @private\n\t* @param {Collection} collection - input collection\n\t* @param {PositiveInteger} n - number of elements\n\t* @param {Callback} done - function to invoke upon completion\n\t* @throws {TypeError} first argument must be a collection\n\t* @throws {TypeError} second argument must be a positive integer\n\t* @throws {TypeError} last argument must be a function\n\t* @returns {void}\n\t*/\n\tfunction someByRightAsync( collection, n, done ) {\n\t\tif ( !isCollection( collection ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a collection. Value: `%s`.', collection ) );\n\t\t}\n\t\tif ( !isPositiveInteger( n ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a positive integer. Value: `%s`.', n ) );\n\t\t}\n\t\tif ( !isFunction( done ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', done ) );\n\t\t}\n\t\treturn limit( collection, n, opts, f, clbk );\n\n\t\t/**\n\t\t* Callback invoked upon completion.\n\t\t*\n\t\t* @private\n\t\t* @param {*} [error] - error\n\t\t* @param {boolean} bool - test result\n\t\t* @returns {void}\n\t\t*/\n\t\tfunction clbk( error, bool ) {\n\t\t\tif ( error ) {\n\t\t\t\treturn done( error, false );\n\t\t\t}\n\t\t\tdone( null, bool );\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Tests whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.\n*\n* ## Notes\n*\n* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.\n* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).\n*\n* @param {Collection} collection - input collection\n* @param {PositiveInteger} n - number of elements\n* @param {Options} [options] - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @param {boolean} [options.series=false] - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection\n* @param {Function} predicate - predicate function to invoke for each element in a collection\n* @param {Callback} done - function to invoke upon completion\n* @throws {TypeError} first argument must be a collection\n* @throws {TypeError} second argument must be a positive integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {TypeError} second-to-last argument must be a function\n* @throws {TypeError} last argument must be a function\n* @returns {void}\n*\n* @example\n* var readFile = require( '@stdlib/fs-read-file' );\n*\n* function done( error, bool ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     if ( bool ) {\n*         console.log( 'Successfully read some files.' );\n*     } else {\n*         console.log( 'Unable to read some files.' );\n*     }\n* }\n*\n* function predicate( file, next ) {\n*     var opts = {\n*         'encoding': 'utf8'\n*     };\n*     readFile( file, opts, onFile );\n*\n*     function onFile( error ) {\n*         if ( error ) {\n*             return next( null, false );\n*         }\n*         next( null, true );\n*     }\n* }\n*\n* var files = [\n*     './beep.js',\n*     './boop.js'\n* ];\n*\n* someByRightAsync( files, 2, predicate, done );\n*/\nfunction someByRightAsync( collection, n, options, predicate, done ) {\n\tif ( arguments.length < 5 ) {\n\t\treturn factory( options )( collection, n, predicate );\n\t}\n\tfactory( options, predicate )( collection, n, done );\n}\n\n\n// EXPORTS //\n\nmodule.exports = someByRightAsync;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Test whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.\n*\n* @module @stdlib/utils-async-some-by-right\n*\n* @example\n* var readFile = require( '@stdlib/fs-read-file' );\n* var someByRightAsync = require( '@stdlib/utils-async-some-by-right' );\n*\n* var files = [\n*     './beep.js',\n*     './boop.js'\n* ];\n*\n* function done( error, bool ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     if ( bool ) {\n*         console.log( 'Successfully read some files.' );\n*     } else {\n*         console.log( 'Unable to read some files.' );\n*     }\n* }\n*\n* function predicate( file, next ) {\n*     var opts = {\n*         'encoding': 'utf8'\n*     };\n*     readFile( file, opts, onFile );\n*\n*     function onFile( error ) {\n*         if ( error ) {\n*             return next( null, false );\n*         }\n*         next( null, true );\n*     }\n* }\n*\n* someByRightAsync( files, 2, predicate, done );\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAoB,QAAS,oCAAqC,EAAE,YACpEC,EAAS,QAAS,uBAAwB,EA4B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,GAGnBN,EAAYM,EAAS,SAAU,IACnCD,EAAK,QAAUC,EAAQ,SAEnBN,EAAYM,EAAS,QAAS,IAClCD,EAAK,OAASC,EAAQ,OACjB,CAACL,EAAWI,EAAK,MAAO,GACrB,IAAI,UAAWF,EAAQ,+DAAgE,SAAUE,EAAK,MAAO,CAAE,EAGnHL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACJ,EAAmBG,EAAK,KAAM,GAC5B,IAAI,UAAWF,EAAQ,wEAAyE,QAASE,EAAK,KAAM,CAAE,EAGxH,MAjBC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAkBhH,CAKAR,EAAO,QAAUM,IC/EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,OAAQ,EAK1BC,EAAQD,EAAQ,2BAA4B,EAkBhD,SAASE,EAAOC,EAAYC,EAAGC,EAAMC,EAAWC,EAAO,CACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAH,EAAMR,EAAW,OACjBF,EAAO,wBAAyBU,CAAI,EAE/BA,IAAQ,EACZ,OAAAV,EAAO,mCAAoC,EACpCM,EAAM,KAAM,EAAM,EAa1B,IAXKI,EAAMN,EAAK,MACfK,EAAMC,EAEND,EAAML,EAAK,MAEZJ,EAAO,wBAAyBS,CAAI,EACpCT,EAAO,0BAA2BK,EAAU,MAAO,EAEnDE,EAAQ,EACRI,EAAMD,EACNE,EAAM,EACAC,EAAI,EAAGA,EAAIJ,EAAKI,IAEhBF,EAAM,GACVG,EAAK,EASP,SAASA,GAAO,CACfH,GAAO,EACPX,EAAO,6BAA8BW,EAAK,KAAK,UAAWT,EAAYS,CAAI,CAAE,CAAE,EACzEN,EAAU,SAAW,EACzBA,EAAU,KAAMD,EAAK,QAASF,EAAYS,CAAI,EAAGI,CAAK,EAC3CV,EAAU,SAAW,EAChCA,EAAU,KAAMD,EAAK,QAASF,EAAYS,CAAI,EAAGA,EAAKI,CAAK,EAE3DV,EAAU,KAAMD,EAAK,QAASF,EAAYS,CAAI,EAAGA,EAAKT,EAAYa,CAAK,CAEzE,CAUA,SAASA,EAAMC,EAAOC,EAAS,CAC9B,GAAK,CAAAT,EAIL,IAAKQ,EACJ,OAAAR,EAAM,GACNR,EAAO,2BAA4BgB,EAAM,OAAQ,EAC1CV,EAAMU,CAAM,EAMpB,GAJAT,GAAS,EACTP,EAAO,0CAA2CO,EAAOG,CAAI,EAE7DV,EAAO,kBAAmB,CAAC,CAACiB,CAAO,EAC9BA,GAAU,CAACT,IACfI,GAAO,EACFA,IAAQT,GACZ,OAAAK,EAAM,GACNR,EAAO,mCAAoC,EACpCM,EAAM,KAAM,EAAK,EAG1B,GAAKK,EAAM,EACV,OAAOG,EAAK,EAEb,GAAKP,IAAUG,EACd,OAAAV,EAAO,mCAAoC,EACpCM,EAAM,KAAM,EAAM,EAE3B,CACD,CAKAR,EAAO,QAAUG,IC3IjB,IAAAiB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAa,QAAS,4BAA6B,EACnDC,EAAoB,QAAS,oCAAqC,EAAE,YACpEC,EAAe,QAAS,8BAA+B,EACvDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAO,QAAS,gCAAiC,EACjDC,EAAW,IACXC,EAAQ,IAoEZ,SAASC,EAASC,EAASC,EAAY,CACtC,IAAIC,EACAC,EACAC,EAGJ,GADAF,EAAO,CAAC,EACH,UAAU,OAAS,EAAI,CAE3B,GADAC,EAAMN,EAAUK,EAAMF,CAAQ,EACzBG,EACJ,MAAMA,EAEPC,EAAIH,CACL,MACCG,EAAIJ,EAEL,GAAK,CAACR,EAAYY,CAAE,EACnB,MAAM,IAAI,UAAWT,EAAQ,mEAAoES,CAAE,CAAE,EAEtG,OAAKF,EAAK,OACTA,EAAK,MAAQ,EACDA,EAAK,QACjBA,EAAK,MAAQN,GAEPS,EAcP,SAASA,EAAkBC,EAAYC,EAAGC,EAAO,CAChD,GAAK,CAACd,EAAcY,CAAW,EAC9B,MAAM,IAAI,UAAWX,EAAQ,sEAAuEW,CAAW,CAAE,EAElH,GAAK,CAACb,EAAmBc,CAAE,EAC1B,MAAM,IAAI,UAAWZ,EAAQ,6EAA8EY,CAAE,CAAE,EAEhH,GAAK,CAACf,EAAYgB,CAAK,EACtB,MAAM,IAAI,UAAWb,EAAQ,mEAAoEa,CAAK,CAAE,EAEzG,OAAOV,EAAOQ,EAAYC,EAAGL,EAAME,EAAGK,CAAK,EAU3C,SAASA,EAAMC,EAAOC,EAAO,CAC5B,GAAKD,EACJ,OAAOF,EAAME,EAAO,EAAM,EAE3BF,EAAM,KAAMG,CAAK,CAClB,CACD,CACD,CAKApB,EAAO,QAAUQ,ICrKjB,IAAAa,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IAgEd,SAASC,EAAkBC,EAAYC,EAAGC,EAASC,EAAWC,EAAO,CACpE,GAAK,UAAU,OAAS,EACvB,OAAON,EAASI,CAAQ,EAAGF,EAAYC,EAAGE,CAAU,EAErDL,EAASI,EAASC,CAAU,EAAGH,EAAYC,EAAGG,CAAK,CACpD,CAKAP,EAAO,QAAUE,IChCjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isBoolean", "isPositiveInteger", "format", "validate", "opts", "options", "require_limit", "__commonJSMin", "exports", "module", "logger", "debug", "limit", "collection", "n", "opts", "predicate", "done", "count", "flg", "lim", "len", "idx", "cnt", "i", "next", "clbk", "error", "result", "require_factory", "__commonJSMin", "exports", "module", "isFunction", "isPositiveInteger", "isCollection", "format", "PINF", "validate", "limit", "factory", "options", "predicate", "opts", "err", "f", "someByRightAsync", "collection", "n", "done", "clbk", "error", "bool", "require_main", "__commonJSMin", "exports", "module", "factory", "someByRightAsync", "collection", "n", "options", "predicate", "done", "setReadOnly", "main", "factory"]
+}

package/docs/types/index.d.ts

@@ -16,30 +16,30 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/object';
+import { Collection } from '@stdlib/types/array';
 
 /**
 * Interface defining function options.
 */
-interface Options {
+interface Options<T, V> {
 	/**
 	* The maximum number of pending invocations at any one time.
 	*/
 	limit?: number;
 
 	/**
-	* Boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection (default: false).
+	* Boolean indicating whether to sequentially invoke the `predicate` function for each `collection` element. If `true`, the function sets `options.limit=1`.
 	*/
 	series?: boolean;
 
 	/**
 	* Execution context.
 	*/
-	thisArg?: any;
+	thisArg?: ThisParameterType<Predicate<T, V>>;
 }
 
 /**
@@ -76,7 +76,7 @@ type Callback = Nullary | Unary | Binary;
 * @param value - collection value
 * @param next - callback which should be called once the predicate function has finished processing a collection value
 */
-type BinaryPredicate = ( value: any, next: Callback ) => void;
+type BinaryPredicate<T, V> = ( this: V, value: T, next: Callback ) => void;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -85,7 +85,7 @@ type BinaryPredicate = ( value: any, next: Callback ) => void;
 * @param index - collection index
 * @param next - callback which should be called once the `predicate` function has finished processing a collection `value`
 */
-type TernaryPredicate = ( value: any, index: number, next: Callback ) => void;
+type TernaryPredicate<T, V> = ( this: V, value: T, index: number, next: Callback ) => void;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -95,7 +95,7 @@ type TernaryPredicate = ( value: any, index: number, next: Callback ) => void;
 * @param collection - input collection
 * @param next - callback which should be called once the `predicate` function has finished processing a collection `value`
 */
-type QuaternaryPredicate = ( value: any, index: number, collection: Collection, next: Callback ) => void; // tslint-disable-line max-line-length
+type QuaternaryPredicate<T, V> = ( this: V, value: T, index: number, collection: Collection<T>, next: Callback ) => void;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -105,16 +105,16 @@ type QuaternaryPredicate = ( value: any, index: number, collection: Collection,
 * @param collection - input collection
 * @param next - callback which should be called once the `predicate` function has finished processing a collection `value`
 */
-type Predicate = BinaryPredicate | TernaryPredicate | QuaternaryPredicate;
+type Predicate<T, V> = BinaryPredicate<T, V> | TernaryPredicate<T, V> | QuaternaryPredicate<T, V>;
 
 /**
-* Tests whether at least one element in a collection passes a test implemented by a predicate function.
+* Tests whether at least `n` elements in a collection pass a test implemented by a predicate function.
 *
 * @param collection - input collection
 * @param n - number of elements
 * @param done - function to invoke upon completion
 */
-type FactoryFunction = ( collection: Collection, n: number, done: Callback ) => void; // tslint-disable-line max-line-length
+type FactoryFunction<T> = ( collection: Collection<T>, n: number, done: Callback ) => void;
 
 /**
 * Interface for `someByRightAsync`.
@@ -128,7 +128,6 @@ interface SomeByRightAsync {
 	* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 	* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 	*
-	*
 	* @param collection - input collection
 	* @param n - number of elements
 	* @param options - function options
@@ -141,7 +140,7 @@ interface SomeByRightAsync {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -175,7 +174,7 @@ interface SomeByRightAsync {
 	*
 	* someByRightAsync( files, 2, predicate, done );
 	*/
-	( collection: Collection, n: number, options: Options, predicate: Predicate, done: Callback ): void; // tslint-disable-line max-line-length
+	<T = unknown, V = unknown>( collection: Collection<T>, n: number, options: Options<T, V>, predicate: Predicate<T, V>, done: Callback ): void;
 
 	/**
 	* Tests whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.
@@ -185,7 +184,6 @@ interface SomeByRightAsync {
 	* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 	* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 	*
-	*
 	* @param collection - input collection
 	* @param n - number of elements
 	* @param predicate - predicate function to invoke for each element in a collection
@@ -194,7 +192,7 @@ interface SomeByRightAsync {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -228,7 +226,7 @@ interface SomeByRightAsync {
 	*
 	* someByRightAsync( files, 2, predicate, done );
 	*/
-	( collection: Collection, n: number, predicate: Predicate, done: Callback ): void; // tslint-disable-line max-line-length
+	<T = unknown, V = unknown>( collection: Collection<T>, n: number, predicate: Predicate<T, V>, done: Callback ): void;
 
 	/**
 	* Returns a function for testing whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.
@@ -238,7 +236,6 @@ interface SomeByRightAsync {
 	* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 	* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 	*
-	*
 	* @param options - function options
 	* @param options.thisArg - execution context
 	* @param options.limit - maximum number of pending invocations at any one time
@@ -248,7 +245,7 @@ interface SomeByRightAsync {
 	* @returns function which invokes the predicate function once for each element in a collection
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function predicate( file, next ) {
 	*     var opts = {
@@ -292,7 +289,7 @@ interface SomeByRightAsync {
 	* // Try to read each element in `files`:
 	* someByRightAsync( files, 2, done );
 	*/
-	factory( options: Options, predicate: Predicate ): FactoryFunction;
+	factory<T = unknown, V = unknown>( options: Options<T, V>, predicate: Predicate<T, V> ): FactoryFunction<T>;
 
 	/**
 	* Returns a function for testing whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.
@@ -302,13 +299,12 @@ interface SomeByRightAsync {
 	* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 	* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 	*
-	*
 	* @param predicate - predicate function to invoke for each element in a collection
 	* @throws must provide valid options
 	* @returns function which invokes the predicate function once for each element in a collection
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function predicate( file, next ) {
 	*     var opts = {
@@ -352,7 +348,7 @@ interface SomeByRightAsync {
 	* // Try to read each element in `files`:
 	* someByRightAsync( files, 2, done );
 	*/
-	factory( predicate: Predicate ): FactoryFunction;
+	factory<T = unknown, V = unknown>( predicate: Predicate<T, V> ): FactoryFunction<T>;
 }
 
 /**
@@ -363,7 +359,6 @@ interface SomeByRightAsync {
 * -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 * -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 *
-*
 * @param collection - input collection
 * @param n - number of elements
 * @param options - function options
@@ -376,7 +371,7 @@ interface SomeByRightAsync {
 * @throws must provide valid options
 *
 * @example
-* var readFile = require( `@stdlib/fs/read-file` );
+* var readFile = require( '@stdlib/fs-read-file' );
 *
 * function done( error, bool ) {
 *     if ( error ) {

package/lib/factory.js

@@ -23,6 +23,7 @@
 var isFunction = require( '@stdlib/assert-is-function' );
 var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;
 var isCollection = require( '@stdlib/assert-is-collection' );
+var format = require( '@stdlib/string-format' );
 var PINF = require( '@stdlib/constants-float64-pinf' );
 var validate = require( './validate.js' );
 var limit = require( './limit.js' );
@@ -38,7 +39,6 @@ var limit = require( './limit.js' );
 * -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 * -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 *
-*
 * @param {Options} [options] - function options
 * @param {*} [options.thisArg] - execution context
 * @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time
@@ -110,7 +110,7 @@ function factory( options, predicate ) {
 		f = options;
 	}
 	if ( !isFunction( f ) ) {
-		throw new TypeError( 'invalid argument. Last argument must be a function. Value: `'+f+'`.' );
+		throw new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', f ) );
 	}
 	if ( opts.series ) {
 		opts.limit = 1;
@@ -133,13 +133,13 @@ function factory( options, predicate ) {
 	*/
 	function someByRightAsync( collection, n, done ) {
 		if ( !isCollection( collection ) ) {
-			throw new TypeError( 'invalid argument. First argument must be a collection. Value: `'+collection+'.`' );
+			throw new TypeError( format( 'invalid argument. First argument must be a collection. Value: `%s`.', collection ) );
 		}
 		if ( !isPositiveInteger( n ) ) {
-			throw new TypeError( 'invalid argument. Second argument must be a positive integer. Value: `'+n+'`.' );
+			throw new TypeError( format( 'invalid argument. Second argument must be a positive integer. Value: `%s`.', n ) );
 		}
 		if ( !isFunction( done ) ) {
-			throw new TypeError( 'invalid argument. Last argument must be a function. Value: `'+done+'`.' );
+			throw new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', done ) );
 		}
 		return limit( collection, n, opts, f, clbk );
 

package/lib/index.js

@@ -63,15 +63,15 @@
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var someByRightAsync = require( './some_by_right.js' );
+var main = require( './main.js' );
 var factory = require( './factory.js' );
 
 
 // MAIN //
 
-setReadOnly( someByRightAsync, 'factory', factory );
+setReadOnly( main, 'factory', factory );
 
 
 // EXPORTS //
 
-module.exports = someByRightAsync;
+module.exports = main;

package/lib/{some_by_right.js → main.js}

@@ -33,7 +33,6 @@ var factory = require( './factory.js' );
 * -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 * -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 *
-*
 * @param {Collection} collection - input collection
 * @param {PositiveInteger} n - number of elements
 * @param {Options} [options] - function options

package/lib/validate.js

@@ -24,6 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;
 var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -53,7 +54,7 @@ var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimit
 */
 function validate( opts, options ) {
 	if ( !isObject( options ) ) {
-		return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'thisArg' ) ) {
 		opts.thisArg = options.thisArg;
@@ -61,13 +62,13 @@ function validate( opts, options ) {
 	if ( hasOwnProp( options, 'series' ) ) {
 		opts.series = options.series;
 		if ( !isBoolean( opts.series ) ) {
-			return new TypeError( 'invalid option. `series` option must be a boolean primitive. Option: `' + opts.series + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'series', opts.series ) );
 		}
 	}
 	if ( hasOwnProp( options, 'limit' ) ) {
 		opts.limit = options.limit;
 		if ( !isPositiveInteger( opts.limit ) ) {
-			return new TypeError( 'invalid option. `limit` option must be a positive integer. Option: `' + opts.limit + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a positive integer. Option: `%s`.', 'limit', opts.limit ) );
 		}
 	}
 	return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-async-some-by-right",
-  "version": "0.0.8",
+  "version": "0.2.0",
   "description": "Test whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.",
   "license": "Apache-2.0",
   "author": {
@@ -37,24 +37,27 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-boolean": "^0.0.x",
-    "@stdlib/assert-is-collection": "^0.0.x",
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/assert-is-plain-object": "^0.0.x",
-    "@stdlib/assert-is-positive-integer": "^0.0.x",
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "debug": "^2.6.9"
+    "@stdlib/assert-has-own-property": "^0.1.1",
+    "@stdlib/assert-is-boolean": "^0.2.0",
+    "@stdlib/assert-is-collection": "^0.2.0",
+    "@stdlib/assert-is-function": "^0.2.0",
+    "@stdlib/assert-is-plain-object": "^0.2.0",
+    "@stdlib/assert-is-positive-integer": "^0.2.0",
+    "@stdlib/constants-float64-pinf": "^0.2.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/types": "^0.3.1",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
+    "debug": "^2.6.9",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.1"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/utils-noop": "^0.0.x",
+    "@stdlib/fs-read-file": "^0.1.1",
+    "@stdlib/utils-noop": "^0.2.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
+    "@stdlib/bench-harness": "^0.1.2",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -97,7 +100,7 @@
     "validate"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,213 +0,0 @@
-
-{{alias}}( collection, n, [options,] predicate, done )
-    Tests whether a collection contains at least `n` elements which pass a test
-    implemented by a predicate function, iterating from right to left.
-
-    When invoked, the predicate function is provided a maximum of four
-    arguments:
-
-    - `value`: collection value
-    - `index`: collection index
-    - `collection`: the input collection
-    - `next`: a callback to be invoked after processing a collection `value`
-
-    The actual number of provided arguments depends on function length. If the
-    predicate function accepts two arguments, the predicate function is
-    provided:
-
-    - `value`
-    - `next`
-
-    If the predicate function accepts three arguments, the predicate function is
-    provided:
-
-    - `value`
-    - `index`
-    - `next`
-
-    For every other predicate function signature, the predicate function is
-    provided all four arguments.
-
-    The `next` callback takes two arguments:
-
-    - `error`: error argument
-    - `result`: test result
-
-    If a provided function calls the `next` callback with a truthy `error`
-    argument, the function suspends execution and immediately calls the `done`
-    callback for subsequent `error` handling.
-
-    The function immediately returns upon receiving `n` non-falsy `result`
-    values and calls the `done` callback with `null` as the first argument and
-    `true` as the second argument.
-
-    If all elements fail, the function calls the `done` callback with `null`
-    as the first argument and `false` as the second argument.
-
-    Execution is *not* guaranteed to be asynchronous. To guarantee asynchrony,
-    wrap the `done` callback in a function which either executes at the end of
-    the current stack (e.g., `nextTick`) or during a subsequent turn of the
-    event loop (e.g., `setImmediate`, `setTimeout`).
-
-    The function does not support dynamic collection resizing.
-
-    The function does not skip `undefined` elements.
-
-    Parameters
-    ----------
-    collection: Array|TypedArray|Object
-        Input collection over which to iterate. If provided an object, the
-        object must be array-like (excluding strings and functions).
-
-    n: number
-        Minimum number of successful elements.
-
-    options: Object (optional)
-        Function options.
-
-    options.limit: integer (optional)
-        Maximum number of pending invocations. Default: Infinity.
-
-    options.series: boolean (optional)
-        Boolean indicating whether to process each collection element
-        sequentially. Default: false.
-
-    options.thisArg: any (optional)
-        Execution context.
-
-    predicate: Function
-        The test function to invoke for each element in a collection.
-
-    done: Function
-        A callback invoked either upon processing all collection elements or
-        upon encountering an error.
-
-    Examples
-    --------
-    // Basic usage:
-    > function predicate( value, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, false );
-    ...     }
-    ... };
-    > function done( error, bool ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( bool );
-    ... };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, 2, predicate, done )
-    1000
-    2500
-    3000
-    false
-
-    // Limit number of concurrent invocations:
-    > function predicate( value, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, false );
-    ...     }
-    ... };
-    > function done( error, bool ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( bool );
-    ... };
-    > var opts = { 'limit': 2 };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, 2, opts, predicate, done )
-    2500
-    3000
-    1000
-    false
-
-    // Process sequentially:
-    > function predicate( value, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, false );
-    ...     }
-    ... };
-    > function done( error, bool ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( bool );
-    ... };
-    > var opts = { 'series': true };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, 2, opts, predicate, done )
-    3000
-    2500
-    1000
-    false
-
-
-{{alias}}.factory( [options,] predicate )
-    Returns a function which tests whether a collection contains at least `n`
-    elements which pass a test implemented by a predicate function, iterating
-    from right to left.
-
-    Parameters
-    ----------
-    options: Object (optional)
-        Function options.
-
-    options.limit: integer (optional)
-        Maximum number of pending invocations. Default: Infinity.
-
-    options.series: boolean (optional)
-        Boolean indicating whether to process each collection element
-        sequentially. Default: false.
-
-    options.thisArg: any (optional)
-        Execution context.
-
-    predicate: Function
-        The test function to invoke for each element in a collection.
-
-    Returns
-    -------
-    out: Function
-        A function which tests each element in a collection.
-
-    Examples
-    --------
-    > function predicate( value, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, false );
-    ...     }
-    ... };
-    > var opts = { 'series': true };
-    > var f = {{alias}}.factory( opts, predicate );
-    > function done( error, bool ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( bool );
-    ... };
-    > var arr = [ 1000, 2500, 3000 ];
-    > f( arr, 2, done )
-    3000
-    2500
-    1000
-    false
-    > arr = [ 1000, 1500, 2000 ];
-    > f( arr, 2, done )
-    2000
-    1500
-    1000
-    false
-
-    See Also
-    --------
-