@barchart/common-js/specifications/GreaterThan.js

Library of common JavaScript utilities

import * as assert from './../lang/assert.js';

import Specification from './Specification.js';

/**
 * A {@link Specification} that passes when the value of the data item
 * exceeds the value passed to the constructor.
 *
 * @public
 * @extends {Specification}
 */
export default class GreaterThan extends Specification {
	#value;

	/**
	 * @param {number} value
	 */
	constructor(value) {
		super();

		assert.argumentIsRequired(value, 'value', Number);

		this.#value = value;
	}

	/**
	 * @protected
	 * @override
	 * @param {*} data
	 * @returns {boolean}
	 */
	_evaluate(data) {
		assert.argumentIsRequired(data, 'data', Number);

		return data > this.#value;
	}

	/**
	 * Returns a string representation.
	 *
	 * @public
	 * @returns {string}
	 */
	toString() {
		return '[GreaterThan]';
	}
}