Interface: ProgressSettings

Defined in: types.ts:100

Shared option object accepted by all rules.

This same shape is also accepted by the deprecated settings.progress fallback for backwards compatibility.

Properties

detailedSuccess?

optional detailedSuccess?: boolean;

Defined in: types.ts:101

---

failureMark?

optional failureMark?: string;

Defined in: types.ts:102

---

fileNameOnNewLine?

optional fileNameOnNewLine?: boolean;

Defined in: types.ts:103

---

hide?

optional hide?: boolean;

Defined in: types.ts:104

---

hideDirectoryNames?

optional hideDirectoryNames?: boolean;

Defined in: types.ts:108

Legacy compatibility alias. Prefer pathFormat: "basename" instead.

---

hideFileName?

optional hideFileName?: boolean;

Defined in: types.ts:109

---

hidePrefix?

optional hidePrefix?: boolean;

Defined in: types.ts:110

---

minFilesBeforeShow?

optional minFilesBeforeShow?: number;

Defined in: types.ts:111

---

mode?

optional mode?: ProgressMode;

Defined in: types.ts:112

---

outputStream?

optional outputStream?: OutputStream;

Defined in: types.ts:113

---

pathFormat?

optional pathFormat?: ProgressPathFormat;

Defined in: types.ts:114

---

prefixMark?

optional prefixMark?: string;

Defined in: types.ts:115

---

showSummaryWhenHidden?

optional showSummaryWhenHidden?: boolean;

Defined in: types.ts:116

---

spinnerStyle?

optional spinnerStyle?: SpinnerStyle;

Defined in: types.ts:117

---

successMark?

optional successMark?: string;

Defined in: types.ts:118

---

successMessage?

optional successMessage?: string;

Defined in: types.ts:119

---

throttleMs?

optional throttleMs?: number;

Defined in: types.ts:120

---

ttyOnly?

optional ttyOnly?: boolean;

Defined in: types.ts:121