Interface: ProgressSettings
Defined in: types.ts:19
Secondary options accepted by file-progress/activate.
Properties
detailedSuccess?
optional detailedSuccess?: boolean;
Defined in: types.ts:21
Include observed-file counts and process timing in summaries.
failureMark?
optional failureMark?: string;
Defined in: types.ts:23
Mark preceding a nonzero process exit summary.
fileNameOnNewLine?
optional fileNameOnNewLine?: boolean;
Defined in: types.ts:25
Place the filename below the progress prefix.
hide?
optional hide?: boolean;
Defined in: types.ts:27
Suppress output, unless showSummaryWhenHidden is enabled.
hideDirectoryNames?
optional hideDirectoryNames?: boolean;
Defined in: types.ts:29
Deprecated
Use pathFormat: "basename".
hideFileName?
optional hideFileName?: boolean;
Defined in: types.ts:31
Display generic activity instead of paths.
hidePrefix?
optional hidePrefix?: boolean;
Defined in: types.ts:33
Omit the SFP prefix.
minFilesBeforeShow?
optional minFilesBeforeShow?: number;
Defined in: types.ts:35
Minimum observed events before output is shown.
mode?
optional mode?: ProgressMode;
Defined in: types.ts:37
Default: file.
outputStream?
optional outputStream?: OutputStream;
Defined in: types.ts:39
Default: stderr, preserving formatted stdout.
pathFormat?
optional pathFormat?: ProgressPathFormat;
Defined in: types.ts:41
Default: relative; explicit values override the deprecated alias.
prefixMark?
optional prefixMark?: string;
Defined in: types.ts:43
Separator following the SFP prefix.
showSummaryWhenHidden?
optional showSummaryWhenHidden?: boolean;
Defined in: types.ts:45
Allow a summary while hide is enabled.
spinnerStyle?
optional spinnerStyle?: SpinnerStyle;
Defined in: types.ts:47
Default: dots.
successMark?
optional successMark?: string;
Defined in: types.ts:49
Mark preceding a zero process exit summary.
successMessage?
optional successMessage?: string;
Defined in: types.ts:51
Text for a zero process exit; not an assertion of zero warnings.
throttleMs?
optional throttleMs?: number;
Defined in: types.ts:53
Minimum milliseconds between displayed filenames.
ttyOnly?
optional ttyOnly?: boolean;
Defined in: types.ts:55
Suppress all output when the selected stream is not a terminal.