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 (38 lines) | stat: -rw-r--r-- 1,006 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

{{alias}}( iterFcn[, ...args] )
    Returns an iterator "thunk".

    A provided iterator function should have the following function signature:

      iterFcn( iterator, ...args )

    The returned function expects a single argument, an iterator.

    This function is useful within the context of iterator pipelines as a means
    to defer execution until a pipeline is ready for data flow.

    Parameters
    ----------
    iterFcn: Function
        Iterator function.

    args: ...any (optional)
        Function arguments.

    Returns
    -------
    fcn( iter ): Function
        Function which accepts a single argument, an iterator, and invokes a
        previously provided iterator function with the provided iterator and any
        previously provided arguments.

    Examples
    --------
    > var fcn = {{alias}}( {{alias:@stdlib/iter/some}}, 3 );
    > var arr = {{alias:@stdlib/array/to-iterator}}( [ 0, 0, 1, 1, 1 ] );
    > var bool = fcn( arr )
    true

    See Also
    --------