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

Library of common JavaScript utilities

const assert = require('./../lang/assert');

const Specification = require('./Specification');

module.exports = (() => {
	'use strict';

	/**
	 * A {@link Specification} that passes when an array (passed to the
	 * constructor) contains the data item.
	 *
	 * @public
	 * @extends {Specification}
	 * @param {Array} value
	 */
	class Contained extends Specification {
		constructor(value) {
			super();

			assert.argumentIsArray(value, 'value');

			this._value = value;
		}

		_evaluate(data) {
			return this._value.some((candidate) => candidate === data);
		}

		toString() {
			return '[Contained]';
		}
	}

	return Contained;
})();