@log-right/base > ReportConfigBase
ReportConfigBase interface​
Report configuration parameters to be applied to a specific event type
export interface ReportConfigBase<TFormat extends FormatFunctionBase = FormatFunctionBase, TCapture extends CaptureFunctionBase = CaptureFunctionBase> extends EventConfig
Properties​
| Property | Type | Description |
|---|---|---|
| capture | TCapture | The default function that will be used to capture the Report. Can be overridden by the user to apply custom logging. The default functionality will try to write the Report to the console. |
| format | TFormat | The default function that will be used to format the Report. Can be overridden by the user to apply custom formatting. The default functionality will try to use the template and Result object and into a Report string. |
| isIncludingStack | boolean | An indicator specifying if a stack trace should be included in the Report |
| locale? | Locale | null | (Optional) The locale object to use when formatting the timestamp |
| messagePostfix? | string | null | (Optional) A postfix string to append to the end of all Report messages |
| messagePrefix? | string | null | (Optional) A prefix string to prepend to the start of all Report messages |
| template? | string | (Optional) A string specifying the report template to use when formatting the Report for this event type |
| templateFieldStart | string | The string used to mark the beginning of a field token in a Report template string |
| templateFieldStop | string | The string used to mark the end of a field token in a Report template string |
| timestampFormat | string | A string used to format the timestamp value appended to the Report event |