Class SplitDataWriter

Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).

Hierarchy (View Summary)

SplitDataWriter
- SplitZipWriter

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

new SplitDataWriter(
    writerGenerator: AsyncGenerator<
        WritableStream<any>
        | WritableWriter
        | Writer<unknown>,
        boolean,
        any,
    >,
    maxSize?: number,
): SplitDataWriter
Creates the SplitDataWriter instance
Parameters
- writerGenerator: AsyncGenerator<
      WritableStream<any>
      | WritableWriter
      | Writer<unknown>,
      boolean,
      any,
  >
  A generator of Writer instances.
- OptionalmaxSize: number
  The maximum size of the data written into Writer instances (default: 4GB).
Returns SplitDataWriter
- Defined in index.d.ts:613

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

Methods

init

init(): Promise<void>
Initializes the instance asynchronously

Returns Promise<void>
Implementation of Initializable.init
- Defined in index.d.ts:606