src/MeboErrors/NoContent.js

const MeboError = require('../MeboError');
const Settings = require('../Settings');


/**
 * Exception raised when the required resource that should be updated does not exist.
 *
 * This error is provided by Mebo to complement the rest support ({@link Web.restful}),
 * although the main purpose is to provide a status code which is used when reporting
 * it through requests, it can still be used when an action is executed
 * through a different handler since it defines a custom exception type that can be
 * used to identify the error.
 *
 * @see {@link Writer._errorOutput}
 */
class NoContent extends MeboError{

  constructor(message='No Content'){
    super(message);

    /**
     * Status code used by the {@link Handler} when this error is raised from inside of a top
     * level action (an action that has not been created from another action).
     *
     * Value driven by:
     * `Settings.get('error/noContent/status')`
     * (default: `204`)
     *
     * @type {number}
     */
    this.status = Settings.get('error/noContent/status');

    /**
     * Boolean telling if this error is not allowed as output ({@link Handler.output})
     * when it has been raised from a nested action (an action created from another
     * action ({@link Action.createAction})). When output is disabled the error
     * will not be handled by the {@link Writer}, therefore the error will be
     * emitted by the signal {@link Handler.onErrorDuringOutput}.
     *
     * Value driven by:
     * `Settings.get('error/noContent/disableOutputInNested')`
     * (default: `false`)
     *
     * @type {boolean}
     */
    this.disableOutputInNested = Settings.get('error/noContent/disableOutputInNested');
  }
}

// default settings
Settings.set('error/noContent/status', 204);
Settings.set('error/noContent/disableOutputInNested', false);

module.exports = NoContent;