National Preventative Mechanism

    @stdlib/array-base-filled-by
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.2 • Public • Published

    filledBy

    NPM version Build Status Coverage Status

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

    Installation

    npm install @stdlib/array-base-filled-by

    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 ]

    Notice

    This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

    For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/array-base-filled-by

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    199

    Version

    0.0.2

    License

    Apache-2.0

    Unpacked Size

    38.6 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser