guardNumberBetween()

guardNumberBetween()

Guards the value to be number type or instance of Number between the specified range.

guard-number-between.func.ts

const guardNumberBetween = <
  Type extends AnyNumber,
  Min extends number,
  Max extends number,
  Payload extends object = object
>(
  value: Type,
  min: Min,
  max: Max,
  callback?: ResultCallback<Type, { min: Min; max: Max } & Payload>,
  payload?: Payload
): value is NumberBetween<Min, Max, Type> =>
  isNumberBetween(value, min, max, callback, payload);

type/guard-number-between.func.ts at main · angular-package/typeGitHub

Generic type variables

TypeextendsAnyNumber

A generic type variable Type constrained by generic type AnyNumber indicates captured number type of the supplied value via the return type and the value parameter of the provided callback function ResultCallback type.

Minextendsnumber

A generic type variable Min constrained by the number type, by default of value captured from the supplied min indicates the fixed shape payload parameter type of the provided callback function ResultCallback type and the minimum range of the provided value via the return type.

Maxextendsnumber

A generic type variable Max constrained by the number type, by default of value captured from the supplied max indicates the fixed shape payload parameter type of the provided callback function ResultCallback type and the maximum range of the provided value via the return type.

Payloadextendsobject=object

The Payload generic type variable constrained by object indicates the type of optional parameter payload of the supplied callback function and payload optional parameter of the guardNumberBetween() function from which it captures its value.

Parameters

value: Type

The value of generic type variable Type to guard.

min: Min

The minimum range of generic type variable Min for a given value.

max: Max

The maximum range of generic type variable Max for a given value.

callback?: ResultCallback<Type, { min: Min; max: Max } & Payload>

The optional callback function of ResultCallback type with parameters, the value that has been checked, the result of this check, and payload of generic type variable Payload with optional properties from the provided payload, to handle them before the result return. By default, it uses resultCallback() function.

The payload parameter of the callback function consists of the min and max properties of the given min and max parameters, and they can't be overwritten by the given payload parameter of the main function.

payload?: Payload

An optional object of the generic type variable Payload is assigned to the payload of the given callback function.

Return type

value is NumberBetween<Min, Max, Type>

The return type is a boolean as the result of its statement indicating the value is a generic type NumberBetween that takes generic type variables Min and Max as a range of the supplied value and Type as the type of the supplied value.

Returns

The return value is a boolean indicating whether the value is a number type or an instance of Number between the specified range.

Example usage

// Example usage.
import { guardNumberBetween } from '@angular-package/type';

guardNumberBetween(Infinity, 0, 0); // false, value is number
guardNumberBetween(NaN, 0, 0); // false, value is number
guardNumberBetween(new Number(Infinity), 0, 0); // false, value is Number
guardNumberBetween(new Number(NaN), 0, 0); // false, value is Number

// Minimum.
guardNumberBetween(3, 3, 100); // true, value is number
guardNumberBetween(new Number(3), 2, 100); // true, value is Number
guardNumberBetween(3, 4, 100); // false, value is number

// Maximum.
guardNumberBetween(3, 0, 3); // true, value is number
guardNumberBetween(3, 0, 2); // false, value is number

// Minimum and Maximum.
guardNumberBetween(3, 1, 3); // true, value is number
guardNumberBetween(3, 4, 2); // false, value is number