abstract.mjs

/**
 * Copyright schukai GmbH and contributors 2023. All Rights Reserved.
 * Node module: @schukai/monster
 * This file is licensed under the AGPLv3 License.
 * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
 */

import { Base } from "../types/base.mjs";
import { instanceSymbol } from "../constants.mjs";

export { AbstractConstraint };

/**
 * Constraints are used to define conditions that must be met by the value of a variable.
 *
 * The uniform API of the constraints allows chains to be formed.
 *
 * The abstract constraint defines the api for all constraints. mainly the method isValid() is defined.
 *
 * Derived classes must implement the method isValid().
 *
 * @license AGPLv3
 * @since 1.3.0
 * @copyright schukai GmbH
 * @memberOf Monster.Constraints
 * @summary The abstract constraint
 */
class AbstractConstraint extends Base {
    /**
     *
     */
    constructor() {
        super();
    }

    /**
     * this method must return a promise containing the result of the check.
     *
     * @param {*} value
     * @returns {Promise}
     */
    isValid(value) {
        return Promise.reject(value);
    }

    /**
     * This method is called by the `instanceof` operator.
     * @returns {symbol}
     * @since 2.1.0
     */
    static get [instanceSymbol]() {
        return Symbol.for("@schukai/monster/constraints/abstract-constraint");
    }
}