time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

some_by_right.js (3345B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var factory = require( './factory.js' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Tests whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.
     30 *
     31 * ## Notes
     32 *
     33 * -   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.
     34 * -   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`).
     35 *
     36 *
     37 * @param {Collection} collection - input collection
     38 * @param {PositiveInteger} n - number of elements
     39 * @param {Options} [options] - function options
     40 * @param {*} [options.thisArg] - execution context
     41 * @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time
     42 * @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
     43 * @param {Function} predicate - predicate function to invoke for each element in a collection
     44 * @param {Callback} done - function to invoke upon completion
     45 * @throws {TypeError} first argument must be a collection
     46 * @throws {TypeError} second argument must be a positive integer
     47 * @throws {TypeError} options argument must be an object
     48 * @throws {TypeError} must provide valid options
     49 * @throws {TypeError} second-to-last argument must be a function
     50 * @throws {TypeError} last argument must be a function
     51 * @returns {void}
     52 *
     53 * @example
     54 * var readFile = require( '@stdlib/fs/read-file' );
     55 *
     56 * function done( error, bool ) {
     57 *     if ( error ) {
     58 *         throw error;
     59 *     }
     60 *     if ( bool ) {
     61 *         console.log( 'Successfully read some files.' );
     62 *     } else {
     63 *         console.log( 'Unable to read some files.' );
     64 *     }
     65 * }
     66 *
     67 * function predicate( file, next ) {
     68 *     var opts = {
     69 *         'encoding': 'utf8'
     70 *     };
     71 *     readFile( file, opts, onFile );
     72 *
     73 *     function onFile( error ) {
     74 *         if ( error ) {
     75 *             return next( null, false );
     76 *         }
     77 *         next( null, true );
     78 *     }
     79 * }
     80 *
     81 * var files = [
     82 *     './beep.js',
     83 *     './boop.js'
     84 * ];
     85 *
     86 * someByRightAsync( files, 2, predicate, done );
     87 */
     88 function someByRightAsync( collection, n, options, predicate, done ) {
     89 	if ( arguments.length < 5 ) {
     90 		return factory( options )( collection, n, predicate );
     91 	}
     92 	factory( options, predicate )( collection, n, done );
     93 }
     94 
     95 
     96 // EXPORTS //
     97 
     98 module.exports = someByRightAsync;