Class IssueTracker

IssueTracker is a utility class for tracking issues (errors and warnings) during the validation process. It can throw errors or collect them for later retrieval.

Index

Constructors

Properties

errors location options warnings

Methods

addError addWarning clearAll getErrors getWarnings setDefaults

Constructors

constructor

new IssueTracker(
location: CsvLocationTracker,
options?: IssueTrackerOptions,
): IssueTracker
Parameters
- location: CsvLocationTracker
- Optionaloptions: IssueTrackerOptions
Returns IssueTracker
- Defined in packages/core/src/lib/utils/issue-tracker.ts:39

Properties

`Private`errors

errors: Issue[] = []

location

location: CsvLocationTracker

options

options: IssueTrackerOptionsWithDefaults

`Private`warnings

warnings: Issue[] = []

Methods

addError

addError(message: string, withLocation?: boolean): void
Adds an error message to the issue tracker.
Parameters
- message: string
  The error message to be added.
- withLocation: boolean = true
  should the error message include the location information?
Returns void
- Defined in packages/core/src/lib/utils/issue-tracker.ts:62

addWarning

addWarning(message: string, withLocation?: boolean): void
Adds a warning message to the issue tracker.
Parameters
- message: string
  The warning message to be added.
- withLocation: boolean = true
  should the warning message include the location information?
Returns void
- Defined in packages/core/src/lib/utils/issue-tracker.ts:89

clearAll

clearAll(): void
Clears all collected errors and warnings.

Returns void
- Defined in packages/core/src/lib/utils/issue-tracker.ts:122

getErrors

getErrors(): Issue[]
Gets all collected errors

Returns Issue[]
- Defined in packages/core/src/lib/utils/issue-tracker.ts:108

getWarnings

getWarnings(): Issue[]
Gets all collected warnings

Returns Issue[]
- Defined in packages/core/src/lib/utils/issue-tracker.ts:115

`Private`setDefaults

setDefaults(options?: IssueTrackerOptions): IssueTrackerOptionsWithDefaults
Parameters
- Optionaloptions: IssueTrackerOptions
Returns IssueTrackerOptionsWithDefaults
- Defined in packages/core/src/lib/utils/issue-tracker.ts:46