File: repl.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (42 lines) | stat: -rw-r--r-- 1,036 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

{{alias}}( ...arr[, options] )
    Generates array tuples from input arrays.

    Parameters
    ----------
    arr: ...Array
        Input arrays to be zipped.

    options: Object (optional)
        Options.

    options.trunc: boolean (optional)
        Boolean indicating whether to truncate arrays longer than the shortest
        input array. Default: `true`.

    options.fill: any (optional)
        Fill value used for arrays of unequal length. Default: `null`.

    options.arrays: boolean (optional)
        Boolean indicating whether an input array should be interpreted as an
        array of arrays to be zipped. Default: `false`.

    Returns
    -------
    out: Array
        Array of arrays.

    Examples
    --------
    // Basic usage:
    > var out = {{alias}}( [ 1, 2 ], [ 'a', 'b' ] )
    [ [ 1, 'a' ], [ 2, 'b' ] ]

    // Turn off truncation:
    > var opts = { 'trunc': false };
    > out = {{alias}}( [ 1, 2, 3 ], [ 'a', 'b' ], opts )
    [ [ 1, 'a' ], [ 2, 'b' ], [ 3, null ] ]

    See Also
    --------