EgaLabs / node-ejsception

// Throwable.js

"use strict";

// :: BASIC SETUP

/**

 * The <tt>Throwable</tt> class is the superclass of all errors and exceptions.

 * @param {String} name - The name of the thrown object.

 * @param {String} message - The message describing the thrown object.

 * @param {Number} code - The unique code that identifies the cause of the thrown object.

 * @augments Object

 * @constructor

 * @see https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html

 */

const Throwable = function (name, message, code) {

    // call the 'parent class'

    Object.call(this);

    // check parameter 'name'

    if (name !== null && name !== undefined) {

        if (typeof name !== "string") {

            throw new Error("parameter 'name' must be a 'string'");

        }

        this.name = name;

    }

    // check parameter 'message'

    if (message !== null && message !== undefined) {

        if (typeof message !== "string") {

            throw new Error("parameter 'message' must be a 'string'");

        }

        this.message = message;

    }

    // check parameter 'code'

    if (code !== null && code !== undefined) {

        if (typeof code !== "number") {

            throw new Error("parameter 'code' must be a 'number'");

        }

        this.code = code;

    }

};

// :: INHERITANCE

// set the prototype chain parent to 'Object'

Throwable.prototype = Object.create(Object.prototype);

// set the prototype chain constructor

Throwable.prototype.constructor = Throwable;

// :: PROTOTYPE

/**

 * The name used to identify a thrown object.

 * @type {String}

 * @default

 */

Throwable.prototype.name = "Throwable";

/**

 * The description of the cause of the thrown object.

 * @type {String}

 * @default

 */

Throwable.prototype.message = "thrown";

/**

 * A short code that helps identifying a thrown object.

 * @type {Number}

 * @default

 */

Throwable.prototype.code = null;

/**

 * Gets the string representation of the {@linkcode Throwable} instance.

 * @returns {String} The string representation of the thrown object.

 * @override

 */

Throwable.prototype.toString = function () {

    let str = this.name;

    if (this.code !== null && this.code !== undefined) {

        str += " (0x" + this.code.toString(16) + ')';

    }

    str += ": " + this.message + '.';

    return str;

};

/**

 * Throws an <tt>Error</tt> with the message of the {@linkcode Throwable} instance.

 * @return {Error} The <tt>Error</tt> instance with the same message as the thrown object.

 * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error

 */

Throwable.prototype.native = function () {

    return new Error(this.message);

};

// :: EXPORT

// export the Throwable 'class'

module.exports = Throwable;