@coven/cron@0.3.3

Built and signed on GitHub Actions

Built and signed on GitHub Actions

123456789101112131415161718192021222324252627282930
import type { AllToken } from "./AllToken.ts";
import type { Field } from "./Field.ts";
import { compareRangeOrValue } from "./compareRangeOrValue.ts";
import { isListField } from "./isListField.ts";

/**
 * Checks if given value is included in given field.
 *
 * @example
 * ```typescript
 * compareField(13, 13); // true
 * compareField(13, 99); // false
 * compareField(13, {from: 0, to: 99 }); // true
 * compareField(13, {from: 0, to: 10 }); // false
 * compareField(13, [10, 13]); // true
 * compareField(13, [10, 11, 12]); // false
 * compareField(13, [10, { from: 11, to: 99 }]); // true
 * compareField(13, [5, { from: 10, to: 12 }]); // false
 * ```
 * @param value Value to compare.
 * @param field Field to compare.
 * @returns `true` if value is included in the given `field`, `false` if it isn't.
 */
export const compareField = (
	value: number,
	field: Exclude<Field<number>, AllToken>,
): boolean =>
	isListField(field)
		? field.some(compareRangeOrValue(value))
		: compareRangeOrValue(value)(field);