Class ChunkTransformer<IsAsync>Abstract

constructor

• new ChunkTransformer<IsAsync extends boolean = boolean>(
      chunkSize?: number,
  ): ChunkTransformer<IsAsync>

  Take a non-uniform-size stream of Uint8Arrays, and join them together into uniform size Uint8Arrays. WARNING: Does not perform proper locking so expect issues with parallel async calls!

  Type Parameters

  • IsAsync extends boolean = boolean

  Parameters

  • OptionalchunkSize: number = 2000

    The size of a chunk. May be changed later.

  Returns ChunkTransformer<IsAsync>

resizingIsImmediate

_buffered

• get _buffered(): Uint8Array<ArrayBufferLike>

  Get the currently buffered data. Useful for custom logic

  Returns Uint8Array<ArrayBufferLike>

chunkSize

• get chunkSize(): number

  The size of the buffer. NOT the size that we are allocating for new chunks.

  Returns number

length

• get length(): number

  Returns number

newChunkSize

• get newChunkSize(): number

  The size that the newly allocated buffers should be. Set with .resize

  Returns number

flushUsed

• flushUsed(): MaybePromise<void, IsAsync>

  Flush the used section of the chunk to the handler.

  Returns MaybePromise<void, IsAsync>

AbstracthandleChunk

• handleChunk(chunk: Uint8Array): MaybePromise<void, IsAsync>

  Parameters

  • chunk: Uint8Array

  Returns MaybePromise<void, IsAsync>

lengthChange

• lengthChange(): void

  A listener for a change in the length of the transformer's internal buffer

  Returns void

push

• push(byte: number): CouldBePossiblyPromise<void, IsAsync>

  Write a single byte

  Parameters

  • byte: number

    the byte

  Returns CouldBePossiblyPromise<void, IsAsync>

resize

• resize(
      chunkSize: number,
  ):
      | (
          CouldBePossiblyPromise<void, IsAsync> extends PromiseLike<unknown>
              ? Promise<void>
              : void
      )
      | undefined

  Change the chunk size of the buffer

  Parameters

  • chunkSize: number

    The chunk size

  Returns
      | (
          CouldBePossiblyPromise<void, IsAsync> extends PromiseLike<unknown>
              ? Promise<void>
              : void
      )
      | undefined

write

• write(
      data: number[] | Uint8Array<ArrayBufferLike>,
  ): CouldBePossiblyPromise<void, IsAsync>

  Write a Uint8Array or array

  Parameters

  • data: number[] | Uint8Array<ArrayBufferLike>

    The data to write

  Returns CouldBePossiblyPromise<void, IsAsync>