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 (62 lines) | stat: -rw-r--r-- 1,622 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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

{{alias}}()
    First-in-first-out (FIFO) queue constructor.

    Returns
    -------
    queue: Object
        First-in-first-out queue.

    queue.clear: Function
        Clears the queue.

    queue.first: Function
        Returns the "oldest" queue value (i.e., the value which is "first-out").
        If the queue is empty, the returned value is `undefined`.

    queue.iterator: Function
        Returns an iterator for iterating over a queue. If an environment
        supports Symbol.iterator, the returned iterator is iterable. Note that,
        in order to prevent confusion arising from queue mutation during
        iteration, a returned iterator **always** iterates over a queue
        "snapshot", which is defined as the list of queue elements at the time
        of the method's invocation.

    queue.last: Function
        Returns the "newest" queue value (i.e., the value which is "last-out").
        If the queue is empty, the returned value is `undefined`.

    queue.length: integer
        Queue length.

    queue.pop: Function
        Removes and returns the current "first-out" value from the queue. If the
        queue is empty, the returned value is `undefined`.

    queue.push: Function
        Adds a value to the queue.

    queue.toArray: Function
        Returns an array of queue values.

    queue.toJSON: Function
        Serializes a queue as JSON.

    Examples
    --------
    > var q = {{alias}}();
    > q.push( 'foo' ).push( 'bar' );
    > q.length
    2
    > q.pop()
    'foo'
    > q.length
    1
    > q.pop()
    'bar'
    > q.length
    0

    See Also
    --------