Class Buffer<A>

First-in, first-out (FIFO) buffer (queue) with default item values. Optionally circular based on limit. Can be switched to LIFO with reverse.

Type Parameters

A

Hierarchy

Buffer

Index

Constructors

Properties

#list #reversed length limit

Methods

[iterator] clear dequeue enqueue forEach reverse from

Constructors

constructor

new Buffer<A>(limit?): Buffer<A>
Type Parameters
- A
Parameters
- limit: number = Infinity
  
  The length after which the buffer becomes circular, i.e., discards oldest items.
Returns Buffer<A>
- Defined in src/Buffer.ts:13

Properties

`Private` #list

#list: List<A>

`Private` #reversed

#reversed: boolean = false

length

length: number = 0

`Readonly` limit

limit: number = Infinity

The length after which the buffer becomes circular, i.e., discards oldest items.

Methods

[iterator]

[iterator](): {
    next: (() => {
        done: false;
        value: A;
    } | {
        done: true;
        value: undefined;
    });
    [iterator]() => { next: () => { value: A; done: false; } | { done: true; value: undefined; }; [Symbol.iterator](): ...; };
}
Returns {
    next: (() => {
        done: false;
        value: A;
    } | {
        done: true;
        value: undefined;
    });
    [iterator]() => { next: () => { value: A; done: false; } | { done: true; value: undefined; }; [Symbol.iterator](): ...; };
}
- next: (() => {
      done: false;
      value: A;
  } | {
      done: true;
      value: undefined;
  })
  - - (): {
          done: false;
          value: A;
      } | {
          done: true;
          value: undefined;
      }
    - Returns {
          done: false;
          value: A;
      } | {
          done: true;
          value: undefined;
      }
- [iterator]:function
  - [iterator](): { next: () => { value: A; done: false; } | { done: true; value: undefined; }; [Symbol.iterator](): ...; }
  - Returns { next: () => { value: A; done: false; } | { done: true; value: undefined; }; [Symbol.iterator](): ...; }
    - Defined in src/Buffer.ts:71
- Defined in src/Buffer.ts:58

clear

clear(): void
Returns void
- Defined in src/Buffer.ts:44

dequeue

dequeue(): A
Return the oldest item from the buffer.

Returns A
- Defined in src/Buffer.ts:35

enqueue

enqueue(value): void
Add an item to the end of the buffer.
Parameters
- value: A
Returns void
- Defined in src/Buffer.ts:22

forEach

forEach(f): void
Parameters
- f: ((value) => void)
  - - (value): void
    - Parameters
      
      value: A
      
      Returns void
Returns void
- Defined in src/Buffer.ts:49

reverse

reverse(): Buffer<A>
Returns Buffer<A>
- Defined in src/Buffer.ts:53

`Static` from

from<A>(iterable, limit): Buffer<A>
Type Parameters
- A
Parameters
- iterable: Iterable<A>
- limit: number
Returns Buffer<A>
- Defined in src/Buffer.ts:77

Generated using TypeDoc