X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularBuffer.html;h=578f6b8f275faa3f6aa5e7155b88e606c8abbce6;hb=0aa00166eaa9a8c9b505b4fa7fd5dc50d831b7ef;hp=5cda4cf53ca93a5e933ea08502eea641cbb87d01;hpb=2493c34370d0839614058bb55254fd7aec91b664;p=poolifier.git diff --git a/docs/classes/CircularBuffer.html b/docs/classes/CircularBuffer.html index 5cda4cf5..578f6b8f 100644 --- a/docs/classes/CircularBuffer.html +++ b/docs/classes/CircularBuffer.html @@ -1,16 +1,24 @@ -CircularBuffer | poolifier - v4.0.11

Class CircularBuffer<T>

Circular buffer

-

Type Parameters

T

Index

Constructors

Properties

items -maxArrayIdx -readIdx -writeIdx -

Methods

checkSize +CircularBuffer | poolifier - v4.0.15

Class CircularBuffer`Internal`

Circular buffer designed for positive numbers.

+

Index

Constructors

Properties

Methods

empty +full +get put toArray -

Constructors

constructor

new CircularBuffer<T>(size?): CircularBuffer<T>
Type Parameters
- T
Parameters
- size: number = defaultBufferSize
  Buffer size
  -
Returns CircularBuffer<T>
CircularBuffer
-
- Defined in src/circular-buffer.ts:19

Properties

`Private` items

items: (undefined | T)[]

`Private` `Readonly` maxArrayIdx

maxArrayIdx: number

`Private` `Readonly` readIdx

readIdx: number

`Private` writeIdx

writeIdx: number

Methods

`Private` checkSize

checkSize(size): void
Parameters
- size: number
Returns void
- Defined in src/circular-buffer.ts:46

put

put(data): void
Puts data into buffer
-
Parameters
- data: T
  Data to push
  -
Returns void
- Defined in src/circular-buffer.ts:32

toArray

toArray(): T[]
Returns buffer as array
-
Returns T[]
T[]
-
- Defined in src/circular-buffer.ts:42

\ No newline at end of file +

Constructors

constructor

new CircularBuffer(size?): CircularBuffer
Parameters
- size: number = defaultBufferSize
  Buffer size.
  +
Returns CircularBuffer
CircularBuffer.
+
Default Value
```
defaultBufferSize
+
```
+ +
- Defined in src/circular-buffer.ts:21

Properties

size

size: number

Methods

empty

empty(): boolean
Checks whether the buffer is empty.
+
Returns boolean
Whether the buffer is empty.
+
- Defined in src/circular-buffer.ts:34

full

full(): boolean
Checks whether the buffer is full.
+
Returns boolean
Whether the buffer is full.
+
- Defined in src/circular-buffer.ts:42

get

get(): undefined | number
Gets number from buffer.
+
Returns undefined | number
Number from buffer.
+
- Defined in src/circular-buffer.ts:62

put

put(number): void
Puts number into buffer.
+
Parameters
- number: number
  Number to put into buffer.
  +
Returns void
- Defined in src/circular-buffer.ts:50

toArray

toArray(): number[]
Returns buffer as numbers' array.
+
Returns number[]
Numbers' array.
+
- Defined in src/circular-buffer.ts:77

\ No newline at end of file