Interface AsyncBatchedObjectsOptions<T>

interface AsyncBatchedObjectsOptions<T> {
    size?: number;
    yieldAfter?: number;
    serialize(object, list): void;
}

Type Parameters

T

Hierarchy (view full)

AsyncBatchedBytesOptions
BatchedObjectsOptions<T>
- AsyncBatchedObjectsOptions

Index

Properties

size? yieldAfter?

Methods

Properties

`Optional` size

size?: number

The minimum number of bytes that should be in a batch (default: 1MB)

`Optional` yieldAfter

yieldAfter?: number

If this amount of time passes, yield all the bytes in the batch even if they are below size (default: 0 - e.g. on every tick)

Methods

serialize

serialize(object, list): void
This function should serialize the object and append the result to the passed list
Parameters
- object: T
- list: Uint8ArrayList
Returns void
Inherited from BatchedObjectsOptions.serialize
- Defined in index.ts:78