Interface ExceptionConstructor

Interface of the exception constructor.

interface ExceptionConstructor {
    new ExceptionConstructor(
        name: string,
        message?: string,
        cause?: Error | Exception,
    ): Exception;
    illegalArgumentError(message: string, cause?: Error | Exception): Exception;
    illegalStateError(message: string, cause?: Error | Exception): Exception;
    notImplemented(message: string, cause?: Error | Exception): Exception;
    unknown(message: string, cause?: Error | Exception): Exception;
    wrap(error: Error | Exception, msg?: string): Exception;
    wrap(error: string): Exception;
}

Index

Constructors

Methods

illegalArgumentError illegalStateError notImplemented unknown wrap

Constructors

constructor

new ExceptionConstructor(
    name: string,
    message?: string,
    cause?: Error | Exception,
): Exception
Creates an Exception. For internal use only! Please use the factory methods, to create an Exception!
Parameters
- name: string
  The type name, the default is UNKNOWN.
- Optionalmessage: string
  The associated message.
- Optionalcause: Error | Exception
  The cause of this exception.
Returns Exception
Inherited from BaseExceptionConstructor<Exception, typeof ExceptionNames>.constructor
- Defined in Exception.ts:98
- Defined in Exception.ts:203

Methods

illegalArgumentError

illegalArgumentError(message: string, cause?: Error | Exception): Exception
Factory method for Exceptions of type 'ILLEGAL_ARGUMENT_ERROR'
Parameters
- message: string
- Optionalcause: Error | Exception
Returns Exception
- Defined in Exception.ts:217

illegalStateError

illegalStateError(message: string, cause?: Error | Exception): Exception
Factory method for Exceptions of type 'ILLEGAL_STATE_ERROR'
Parameters
- message: string
- Optionalcause: Error | Exception
Returns Exception
- Defined in Exception.ts:212

notImplemented

notImplemented(message: string, cause?: Error | Exception): Exception
Factory method for Exceptions of type 'NOT_IMPLEMENTED'
Parameters
- message: string
- Optionalcause: Error | Exception
Returns Exception
- Defined in Exception.ts:222

unknown

unknown(message: string, cause?: Error | Exception): Exception
Factory method for Exceptions of type 'UNKNOWN'
Parameters
- message: string
- Optionalcause: Error | Exception
Returns Exception
- Defined in Exception.ts:207

wrap

wrap(error: Error | Exception, msg?: string): Exception
Wraps errors into Exceptions to get correct stacktraces.
Parameters
- error: Error | Exception
  the error
- Optionalmsg: string
  the error message
Returns Exception
Example
```
import Exception from "apprt-core/Exception";

try {
   // code with throws an error
} catch(e) {
   // wrap into exception class to get stacktraces
   throw Exception.wrap(e);
}
```
- Defined in Exception.ts:116
wrap(error: string): Exception
Wraps errors into Exceptions to get correct stacktraces.
Parameters
- error: string
  the error message
Returns Exception
- Defined in Exception.ts:123