Type Alias StreamRestoreResult

what a streaming restore did, and the largest single buffer it held

type StreamRestoreResult = {
    bytesWritten: number;
    chunks: number;
    complete: boolean;
    elidedBytes: number;
    largestChunkBytes: number;
    nextChunk: number;
    totalChunks: number;
}

Properties

bytesWritten: number

chunks: number

complete: boolean

every chunk applied, so the restore is finished and the heap is usable

elidedBytes: number

largestChunkBytes: number

nextChunk: number

the from a resuming call must pass to continue; equals totalChunks when done

totalChunks: number

how many chunks the snapshot has in total, so a caller knows when it is complete