woshilapin / codingame-connector

 * @file Module 'codingame/error'

 * @author woshilapin <[email protected]>

 */

/**

 * Error for Codingame API

 * @module codingame/error

 * @see {@link CodingameError}

 */

class CodingameError extends Error {

	/**

	 * Create an error for reporting Codingame test fails.

	 * Represents errors in a Codingame test which is not a technical error:

	 * - the test didn't pass

	 * - the bundle didn't compile

	 * - the objective of the problem has not been reached

	 * - etc.

	 * @extends Error

	 * @constructs CodingameError

	 * @param {string|Error} error - The message or the parent Error

	 */

	/**

	 * Attach some random metadata to the error

	 * @method attach

	 * @param {Object} metadata - Some random object

	 * @memberof CodingameError

	 * @instance

	 */

	attach(metadata) {

		Object.assign(this.metadata, metadata);

	};

}

export default CodingameError;