isNumberBetween()

isNumberBetween()

Checks if any value is a number type or an instance of Number(by using isNumber()) between a specified range.

is-number-between.func.ts

const isNumberBetween = <
  Type extends AnyNumber = number,
  Min extends number = number,
  Max extends number = number,
  Payload extends object = object
>(
  value: any,
  min: Min,
  max: Max,
  callback: ResultCallback<
    any,
    { min: Min; max: Max } & Payload
  > = resultCallback,
  payload?: Payload
): value is NumberBetween<Min, Max, Type> =>
  callback(
    isNumber(value)
      ? (isNumberType(min) ? value.valueOf() >= min : false) &&
          (isNumberType(max) ? value.valueOf() <= max : false)
      : false,
    value,
    { ...payload, min, max } as any
  );

type/src/is/lib/is-number-between.func.ts at main · angular-package/typeGitHub

Generic type variables

TypeextendsAnyNumber=number

A generic type variable Type constrained by AnyNumber indicates the number type of the given value via the return type, by default number.

Minextendsnumber=number

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

Maxextendsnumber=number

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

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 isNumberBetween() function from which it captures its value.

Parameters

value: any

The value of any type to check.

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<any, { min: Min; max: Max } & Payload>

A 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 given in parameters of the core function, and they can't be overwritten by the given payload parameter of the core 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 finite number of a number type or an instance of Number between a specified range.

Example usage

Type

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

const age = 13;

// true; The return type `value is NumberBetween<0, 13, number>`
isNumberBetween(age, 0, 13);
// false; The return type `value is NumberBetween<14, 28, number>`
isNumberBetween(age, 14, 28);
// false; The return type `value is NumberBetween<0, 12, number>`
isNumberBetween(age, 0, 12);
// true; The return type `value is NumberBetween<13, 13, number>`
isNumberBetween(age, 13, 13);

Instance

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

const ageBox = new Number(age);

// true; The return type `value is NumberBetween<0, 13, Number>`
isNumberBetween(ageBox, 0, 13);
// false; The return type `value is NumberBetween<14, 28, Number>`
isNumberBetween(ageBox, 14, 28);
// false; The return type `value is NumberBetween<0, 12, Number>`
isNumberBetween(ageBox, 0, 12);
// true; The return type `value is NumberBetween<13, 13, Number>`
isNumberBetween(ageBox, 13, 13);