Function ensureErrorClass

  • ensureErrorClass<const ErrorClass extends Constructor<Error>>(
        originalError: unknown,
        errorClass: ErrorClass,
        ...params: ConstructorParameters<ErrorClass>,
    ): InstanceType<ErrorClass>

    Ensures that the given originalError is an instance of the given errorClass.

    • If it is, originalError is directly returned.
    • If it is not, a new instance of errorClass is constructed with the given parameters.

    Type Parameters

    • const ErrorClass extends Constructor<Error>

    Parameters

    Returns InstanceType<ErrorClass>

    Example

    import {ensureErrorClass, extractErrorMessage} from '@augment-vir/common';

    class MyCustomError extends Error {
        public override readonly name = 'MyCustomError';
    }

    try {
        // do some stuff
    } catch (error) {
        throw ensureErrorClass(error, MyCustomError, extractErrorMessage(error));
    }

    Package

    @augment-vir/common

Settings

Member Visibility