Class BytesFIFOChunkBuffer

Hierarchy (View Summary)

ChunkTransformerWithDataCallback<false>
- BytesFIFOChunkBuffer

Index

Constructors

Properties

resizingIsImmediate

Accessors

_buffered chunkSize length newChunkSize

Methods

flush flushUsed handleChunk lengthChange push resize write

Constructors

constructor

new BytesFIFOChunkBuffer(
    chunkSize: number,
    callback: (chunk: Uint8Array) => void,
    alloc: () => Uint8Array<ArrayBufferLike> | undefined,
): BytesFIFOChunkBuffer
Parameters
- chunkSize: number
- callback: (chunk: Uint8Array) => void
- alloc: () => Uint8Array<ArrayBufferLike> | undefined
Returns BytesFIFOChunkBuffer
Overrides ChunkTransformerWithDataCallback.constructor
- Defined in fifo.ts:8

Properties

`Readonly`resizingIsImmediate

resizingIsImmediate: false

Accessors

_buffered

get _buffered(): Uint8Array<ArrayBufferLike>
Get the currently buffered data. Useful for custom logic

Returns Uint8Array<ArrayBufferLike>
Inherited from ChunkTransformerWithDataCallback._buffered
- Defined in chunkBuffer.ts:23

chunkSize

get chunkSize(): number
The size of the buffer. NOT the size that we are allocating for new chunks.

Returns number
Inherited from ChunkTransformerWithDataCallback.chunkSize
- Defined in chunkBuffer.ts:29

length

get length(): number
Returns number
Inherited from ChunkTransformerWithDataCallback.length
- Defined in chunkBuffer.ts:16

newChunkSize

get newChunkSize(): number
The size that the newly allocated buffers should be. Set with .resize

Returns number
Inherited from ChunkTransformerWithDataCallback.newChunkSize
- Defined in chunkBuffer.ts:36

Methods

flush

flush(): void
Flush the currently buffered data to the output. Replaced by .flushUsed

Returns void
Deprecated
Inherited from ChunkTransformerWithDataCallback.flush
- Defined in chunkBuffer.ts:235

flushUsed

flushUsed(): void
Flush the used section of the chunk to the handler.

Returns void
Inherited from ChunkTransformerWithDataCallback.flushUsed
- Defined in chunkBuffer.ts:86

handleChunk

handleChunk(chunk: Uint8Array): void
Parameters
- chunk: Uint8Array
Returns void
Inherited from ChunkTransformerWithDataCallback.handleChunk
- Defined in chunkBuffer.ts:227

lengthChange

lengthChange(): void
A listener for a change in the length of the transformer's internal buffer

Returns void
Inherited from ChunkTransformerWithDataCallback.lengthChange
- Defined in chunkBuffer.ts:43

push

push(byte: number): void
Write a single byte
Parameters
- byte: number
  the byte
Returns void
Inherited from ChunkTransformerWithDataCallback.push
- Defined in chunkBuffer.ts:136

resize

resize(chunkSize: number): void | undefined
Change the chunk size of the buffer
Parameters
- chunkSize: number
  The chunk size
Returns void | undefined
Inherited from ChunkTransformerWithDataCallback.resize
- Defined in chunkBuffer.ts:154

write

write(data: number[] | Uint8Array<ArrayBufferLike>): void
Write a Uint8Array or array
Parameters
- data: number[] | Uint8Array<ArrayBufferLike>
  The data to write
Returns void
Inherited from ChunkTransformerWithDataCallback.write
- Defined in chunkBuffer.ts:105