@brycemarshall/exception

A lightweight implementation of the standard ECMAScript Error interface that is compatible with the @brycemarshall/exception Exception type.

Installation

npm install @brycemarshall/simple-exception

The module exports the following types:

export interface ExceptionLike extends Error {
    readonly isException: boolean;
    readonly stack: string;
    toString(): string;
}
/**
 * The base class for custom error types implementing the standard ECMAScript Error interface.
 * Instances of this type may be instantiated directly (without subclassing) in order to create custom error instances.
 */
export declare class SimpleException implements ExceptionLike {
    readonly name: string;
    readonly message: string;
    readonly stack: string;
    /**
     * Creates a new SimpleException instance.
     * @param errorName The name (implied type) of the Error object implemented by this instance.
     * @param message An optional error message.
    */
    constructor(errorName: string, message?: string);
    /**
     * Returns the error message associated with this instance.
     */
    toString(): string;
    /**
     * Always returns true.
     */
    readonly isException: boolean;
    /**
     * Converts an Error object into an Exception if it is not already.
     * @param error The Error object to convert.
     */
    static convert(error: Error): SimpleException;
    /**
     * Returns true if the specified instance is an Error object, otherwise returns false.
     * @param value The value to test.
     */
    static isError(value: any): boolean;
}

Usage

import { SimpleException } from '@brycemarshall/simple-exception';

try {
    throw new SimpleException("Timeout");
}
catch (e) {
    if (e.isTimeoutException)
        console.log("Caught a TimeoutException");
}

import { SimpleException as Exception } from '@brycemarshall/simple-exception';

try {
    throw new Exception("Foobar", "Your foo is incompatible with my bar.");
}
catch (e) {
    if (e.isFoobarException)
        console.log("Caught a FoobarException");
}

Usage - Native Error Type Identification

import { SimpleException as Exception } from '@brycemarshall/simple-exception';

try {
    throw new RangeError();
}
catch (e) {
    e = Exception.convert(e);
    if (e.isRangeErrorException)
        console.log("Caught an Error of type 'RangeError'");
}

Contributors

• Bryce Marshall

MIT Licenced