@schukai/monster/source/constraints/isobject.mjs

Monster is a simple library for creating fast, robust and lightweight websites.

/**
 * Copyright © Volker Schukai and all contributing authors, {{copyRightYear}}. All rights reserved.
 * Node module: @schukai/monster
 *
 * This source code is licensed under the GNU Affero General Public License version 3 (AGPLv3).
 * The full text of the license can be found at: https://www.gnu.org/licenses/agpl-3.0.en.html
 *
 * For those who do not wish to adhere to the AGPLv3, a commercial license is available.
 * Acquiring a commercial license allows you to use this software without complying with the AGPLv3 terms.
 * For more information about purchasing a commercial license, please contact Volker Schukai.
 *
 * SPDX-License-Identifier: AGPL-3.0
 */

import { isObject } from "../types/is.mjs";
import { AbstractConstraint } from "./abstract.mjs";
import { instanceSymbol } from "../constants.mjs";
export { IsObject };

/**
 * 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.
 *
 * @example /examples/libraries/constraints/isobject/ A simple example
 *
 * @license AGPLv3
 * @since 1.3.0
 * @copyright Volker Schukai
 * @summary A constraint to check if a value is an object
 */
class IsObject extends AbstractConstraint {
	/**
	 * this method returns a promise containing the result of the check.
	 *
	 * @param {*} value
	 * @return {Promise}
	 */
	isValid(value) {
		if (isObject(value)) {
			return Promise.resolve(value);
		}

		return Promise.reject(value);
	}

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