@toreda/strong-types/src/has/length/equal.ts

Better TypeScript code in fewer lines.

/**
 *	MIT License
 *
 *	Copyright (c) 2019 - 2021 Toreda, Inc.
 *
 *	Permission is hereby granted, free of charge, to any person obtaining a copy
 *	of this software and associated documentation files (the "Software"), to deal
 *	in the Software without restriction, including without limitation the rights
 *	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *	copies of the Software, and to permit persons to whom the Software is
 *	furnished to do so, subject to the following conditions:

 * 	The above copyright notice and this permission notice shall be included in all
 * 	copies or substantial portions of the Software.
 *
 * 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * 	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * 	SOFTWARE.
 *
 */

import {Collection} from '../../collection';
import {Rule} from '../../rule';
import {RuleFn} from '../../rule/fn';
import {RuleMods} from '../../rule/mods';
import {RuleNode} from '../../rule/node';
import {RuleNodeType} from '../../rule/node/type';

/**
 * Type signature for hasLengthEqual validator functions used within rule chains.
 *
 * @category Validators
 */
export type HasLengthEqual<CallerT> = (a: number) => CallerT;

/**
 *
 * @param value
 * @param target
 * @returns
 *
 * @category Validators
 */
export function hasLengthEqual(value: unknown[] | string, target: number): boolean {
	if (value === undefined || value === null) {
		return false;
	}

	if (typeof target !== 'number') {
		return false;
	}

	if (typeof value === 'string') {
		return value.length === target;
	}

	if (Array.isArray(value)) {
		return value.length === target;
	}

	const obj = value as Collection;

	if (typeof obj.length !== 'number') {
		return false;
	}

	return obj.length === target;
}

/**
 *
 * @param caller
 * @param rule
 * @param mods
 * @returns
 *
 * @category Validator Factory Functions
 */
export function hasLengthEqualMake<CallerT>(
	caller: CallerT,
	rule: Rule,
	mods: RuleMods
): HasLengthEqual<CallerT> {
	return (target: number): CallerT => {
		const fn: RuleFn<unknown[] | string> = (curr: unknown[] | string) => {
			return hasLengthEqual(curr, target);
		};

		const node = new RuleNode<unknown[] | string>('HAS_LENGTH_EQ', RuleNodeType.CMP, fn, mods);
		rule.add(node);

		return caller;
	};
}