DocumentationError
Summary
Base class for all custom errors in the documentation generation process. It extends the nativeError class with additional structured context.
Signature
Constructors
constructor
Creates an instance of DocumentationError.Properties
code
Modifiers: readonly Type:readonly code: ErrorCode;
Default: “
A standardized, machine-readable error code from the enum. This allows for programmatic handling of different error types.
context
Modifiers: readonly Type:readonly context: ErrorContext;
Default: “
An object containing additional, structured information about the error.
isUserError
Modifiers: readonly Type:readonly isUserError: boolean;
Default: “
A boolean flag indicating whether the error is likely caused by user input () or by a system/internal failure (). This helps in tailoring the error message to the appropriate audience.
timestamp
Modifiers: readonly Type:readonly timestamp: Date;
Default: “
The exact time when the error instance was created.