filledBy

Create a filled "generic" array according to a provided callback function.

Usage

var filledBy = require( '@stdlib/array/base/filled-by' );

filledBy( len, clbk[, thisArg] )

Returns a filled "generic" array according to a provided callback function.

function clbk( i ) {
    return i;
}

var out = filledBy( 3, clbk );
// returns [ 0, 1, 2 ]

When invoked, a callback function is provided a single argument:

  • index: the current array index.

To set the callback execution context, provide a thisArg.

function clbk( i ) {
    this.count += 1;
    return i;
}

var ctx = {
    'count': 0
};

var out = filledBy( 3, clbk, ctx );
// returns [ 0, 1, 2 ];

var cnt = ctx.count;
// returns 3

Examples

var constantFunction = require( '@stdlib/utils/constant-function' );
var filledBy = require( '@stdlib/array/base/filled-by' );

var out = filledBy( 3, constantFunction( 0.0 ) );
// returns [ 0.0, 0.0, 0.0 ]

out = filledBy( 3, constantFunction( 'beep' ) );
// returns [ 'beep', 'beep', 'beep' ]

out = filledBy( 3, constantFunction( null ) );
// returns [ null, null, null ]

out = filledBy( 3, constantFunction( true ) );
// returns [ true, true, true ]

out = filledBy( 3, constantFunction( void 0 ) );
// returns [ undefined, undefined, undefined ]
Did you find this page helpful?