Function formatError

formatError<Throws>(errorType, errorDetails?, throwError?): Throws extends true
? never
: string
A simple method used throughout Libauth to format error messages. By formatting errors this way, downstream consumers can detect specific error types by matching the errorType. For example, the error:
```
formatError(SomeTypeOfError.exceedsMaximum, `Provided value: ${value}`);
```
Can be detected with String.includes(), even if the SomeTypeOfError.exceedsMaximum error message changes:
```
error.includes(SomeTypeOfError.exceedsMaximum);
// => true
```
Using this method ensures consistency across the library.
Type Parameters
- Throws extends boolean
Parameters
- errorType: string
  the error enum member representing this error type
- Optional errorDetails: string
  optional, additional details to include in the error message
- throwError: Throws = ...
  if true, the function will throw an Error rather than returning the string (defaults to false).
Returns Throws extends true
? never
: string
Remarks
In Libauth, expected errors use the type string rather than Error (or other objects that inherit from Error) to simplify the resulting types and typechecking requirements. This ensures consistency of returned errors in all environments, avoids exposing internal details like stack traces and line numbers, and allows error messages to be recorded or used as text without an intermediate toString() method.
- Defined in src/lib/format/error.ts:33

Generated using TypeDoc