Class SplitDataWriter

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

Implements

Index

Constructors

Properties

availableSize diskNumber diskOffset maxSize writable

Methods

Constructors

constructor

new SplitDataWriter(
    writerGenerator: AsyncGenerator<
        WritableStream<any>
        | WritableWriter
        | Writer<unknown>,
        boolean,
    >,
    maxSize?: number,
): SplitDataWriter
Creates the SplitDataWriter instance
Parameters
- writerGenerator: AsyncGenerator<WritableStream<any> | WritableWriter | Writer<unknown>, boolean>
  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:772

Properties

availableSize

availableSize: number

The number of bytes still available on the disk being written.

diskNumber

diskNumber: number

The number of the disk being written.

diskOffset

diskOffset: number

The byte offset of the disk being written.

maxSize

maxSize: number

The maximum size of each disk in bytes.

writable

writable: WritableStream

The WritableStream instance.

Methods

init

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

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