Skip to main content
Dotset CLI API Documentation / index / BatchProfiler

​
Class: BatchProfiler

Defined in: src/shield/utils/profiler.ts:589 Profiler for batch operations

​
Constructors

​
Constructor

new BatchProfiler(
   operation, 
   batchId?, 
   profiler?): BatchProfiler;
Defined in: src/shield/utils/profiler.ts:598

​
Parameters

operation
string
batchId?
string
profiler?

​
Returns

BatchProfiler

​
Methods

​
complete()

complete(): BatchMetrics;
Defined in: src/shield/utils/profiler.ts:623 Complete the batch and get metrics

​
Returns

​
getProgress()

getProgress(): BatchMetrics;
Defined in: src/shield/utils/profiler.ts:644 Get current metrics without completing

​
Returns

​
recordItem()

recordItem(): void;
Defined in: src/shield/utils/profiler.ts:609 Record an item being processed

​
Returns

void

​
recordItems()

recordItems(count): void;
Defined in: src/shield/utils/profiler.ts:616 Record multiple items

​
Parameters

count
number

​
Returns

void