JSDoc exports example

jsdoc-exports-example.js

'use strict';

/**
 * Creates an instance of the StatusCodeErrorItem
 * @memberof common
 * @constructor
 * @classdesc A class for holding information about an error. The params object allows the tracking of the function
 *  parameters that caused the error, but should not be used to store large objects.
 * @description Creates an instance of the StatusCodeErrorItem with the given message and optional params object
 * @param {string} message The message for this error
 * @param {object} [params] The parameters that caused this error to occur
 * @returns {StatusCodeErrorItem}
 * @see {@link module:lib/common/StatusCodeError.StatusCodeError|StatusCodeError}
 */
function StatusCodeErrorItem(message, params) {
    this.message = message;
    this.params = params;
}

/**
 * Surfaces a class that holds information about an error
 * @module lib/common/StatusCodeErrorItem
 */
module.exports = StatusCodeErrorItem;