| 1 | import { TransformOptions, TransformTyped } from '../stream.model';
|
| 2 | export interface TransformLogProgressOptions<IN = any> extends TransformOptions {
|
| 3 | /**
|
| 4 | * Progress metric
|
| 5 | *
|
| 6 | * @default `progress`
|
| 7 | */
|
| 8 | metric?: string;
|
| 9 | /**
|
| 10 | * Include `heapUsed` in log.
|
| 11 | *
|
| 12 | * @default true
|
| 13 | */
|
| 14 | heapUsed?: boolean;
|
| 15 | /**
|
| 16 | * Include `heapTotal` in log.
|
| 17 | *
|
| 18 | * @default false
|
| 19 | */
|
| 20 | heapTotal?: boolean;
|
| 21 | /**
|
| 22 | * Include `rss` in log.
|
| 23 | *
|
| 24 | * @default true
|
| 25 | */
|
| 26 | rss?: boolean;
|
| 27 | /**
|
| 28 | * Include `external` in log.
|
| 29 | *
|
| 30 | * @default false
|
| 31 | */
|
| 32 | external?: boolean;
|
| 33 | /**
|
| 34 | * Include `arrayBuffers` in log.
|
| 35 | *
|
| 36 | * @default false
|
| 37 | */
|
| 38 | arrayBuffers?: boolean;
|
| 39 | /**
|
| 40 | * Log (rss - heapTotal)
|
| 41 | * For convenience of debugging "out-of-heap" memory size.
|
| 42 | *
|
| 43 | * @default false
|
| 44 | */
|
| 45 | rssMinusHeap?: boolean;
|
| 46 | /**
|
| 47 | * Log "rows per second"
|
| 48 | *
|
| 49 | * @default true
|
| 50 | */
|
| 51 | logRPS?: boolean;
|
| 52 | /**
|
| 53 | * @default true
|
| 54 | * Set to false to disable logging progress
|
| 55 | */
|
| 56 | logProgress?: boolean;
|
| 57 | /**
|
| 58 | * Log progress event Nth record that is _processed_ (went through mapper).
|
| 59 | *
|
| 60 | * @default 1000
|
| 61 | * Set to 0 to disable logging.
|
| 62 | */
|
| 63 | logEvery?: number;
|
| 64 | /**
|
| 65 | * Function to return extra properties to the "progress object".
|
| 66 | *
|
| 67 | * chunk is undefined for "final" stats, otherwise is defined.
|
| 68 | */
|
| 69 | extra?: (chunk: IN | undefined, index: number) => Record<string, any>;
|
| 70 | }
|
| 71 | /**
|
| 72 | * Pass-through transform that optionally logs progress.
|
| 73 | */
|
| 74 | export declare function transformLogProgress<IN = any>(opt?: TransformLogProgressOptions): TransformTyped<IN, IN>;
|