constraint/invalid.js

'use strict';

/**
 * @author schukai GmbH
 */

import {Monster, AbstractConstraint} from "./abstract.js";

/**
 * the invalid constraint allows an always invalid query to be performed. this contraint is mainly intended for testing.
 *
 * you can call the method via the monster namespace `new Monster.Constraint.Invalid()`.
 *
 * ```
 * <script type="module">
 * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.2.1/dist/modules/constraint/invalid.js';
 * new Monster.Constraint.Invalid().catch(()=>console.log(true));
 * </script>
 * ```
 *
 * Alternatively, you can also integrate this function individually.
 *
 * ```
 * <script type="module">
 * import {Invalid} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.2.1/dist/modules/constraint/invalid.js';
 * new Invalid().catch(()=>console.log(true));
 * </script>
 * ```
 *
 * @since 1.3.0
 * @copyright schukai GmbH
 * @memberOf Monster/Constraint
 */
class Invalid extends AbstractConstraint {

    /**
     * this method return a rejected promise
     *
     * @param {*} value
     * @returns {Promise}
     */
    isValid(value) {
        return Promise.reject(value);
    }

}

Monster.assignToNamespace('Monster.Constraint', Invalid);
export {Monster, Invalid}