# guardNumberBetween()

## `guardNumberBetween()`

Guards the value to be [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) type or instance of [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) between the specified range.

{% code title="guard-number-between.func.ts" %}

```typescript
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);
```

{% endcode %}

{% embed url="<https://github.com/angular-package/type/blob/main/src/guard/lib/guard-number-between.func.ts>" %}

### Generic type variables

#### <mark style="color:green;">**`Type`**</mark>**`extends`**<mark style="color:green;">**`AnyNumber`**</mark>

A generic type variable `Type` constrained by generic type [`AnyNumber`](https://type.angular-package.dev/type-draft/type/anynumber) indicates captured [`number`](https://www.typescriptlang.org/docs/handbook/basic-types.html#number) type of the supplied [`value`](#value-type) via the [return type](#return-type) and the [`value`](https://type.angular-package.dev/type-draft/type/resultcallback#value-value) parameter of the provided [`callback`](#callback-resultcallback-less-than-type-min-min-max-max-and-payload-greater-than) function [`ResultCallback`](https://type.angular-package.dev/type-draft/type/resultcallback) type.

#### <mark style="color:green;">**`Min`**</mark>**`extends`**<mark style="color:green;">**`number`**</mark>

A generic type variable `Min` constrained by the [`number`](https://www.typescriptlang.org/docs/handbook/basic-types.html#number) type, by default of value captured from the supplied [`min`](#min-min) indicates the fixed shape [`payload`](https://type.angular-package.dev/type-draft/type/resultcallback#payload-payload) parameter type of the provided [`callback`](#callback-resultcallback-less-than-type-min-min-max-max-and-payload-greater-than) function [`ResultCallback`](https://type.angular-package.dev/type-draft/type/resultcallback) type and the **minimum** range of the provided [`value`](#value-type) via the [return type](#return-type).

#### <mark style="color:green;">**`Max`**</mark>**`extends`**<mark style="color:green;">**`number`**</mark>

A generic type variable `Max` constrained by the [`number`](https://www.typescriptlang.org/docs/handbook/basic-types.html#number) type, by default of value captured from the supplied [`max`](#max-max) indicates the fixed shape [`payload`](https://type.angular-package.dev/type-draft/type/resultcallback#payload-payload) parameter type of the provided [`callback`](#callback-resultcallback-less-than-type-min-min-max-max-and-payload-greater-than) function [`ResultCallback`](https://type.angular-package.dev/type-draft/type/resultcallback) type and the **maximum** range of the provided [`value`](#value-type) via the [return type](#return-type).

#### <mark style="color:green;">**`Payload`**</mark>**`extends`**<mark style="color:green;">**`object`**</mark>**`=`**<mark style="color:green;">**`object`**</mark>

The `Payload` generic type variable constrained by [`object`](https://www.typescriptlang.org/docs/handbook/basic-types.html#object) indicates the type of optional parameter [`payload`](https://type.angular-package.dev/type-draft/type/resultcallback#payload-payload) of the supplied [`callback`](#callback-resultcallback-less-than-type-min-min-max-max-and-payload-greater-than) function and [`payload`](#payload-payload) optional parameter of the [`guardNumberBetween()`](#guardnumberbetween) function from which it captures its value.

### Parameters

#### `value: Type`

The value of generic type variable [`Type`](#typeextendsanynumber) to guard.

#### `min: Min`

The **minimum** range of generic type variable [`Min`](#minextendsnumber) for a given [`value`](#value-type).

#### `max: Max`

The **maximum** range of generic type variable [`Max`](#maxextendsnumber) for a given [`value`](#value-type).

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

The optional callback [`function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Functions) of [`ResultCallback`](https://type.angular-package.dev/type-draft/type/resultcallback) type with parameters, the [`value`](#value-type) that has been checked, the `result` of this check, and `payload` of generic type variable [`Payload`](#payloadextendsobject-object) with optional properties from the provided `payload`, to handle them before the `result` return. By default, it uses [`resultCallback()`](https://type.angular-package.dev/type-draft/helper/resultcallback) function.

{% hint style="info" %}
The [`payload`](https://type.angular-package.dev/type-draft/type/resultcallback#payload-payload) parameter of the [`callback`](#callback-resultcallback-less-than-type-min-min-max-max-and-payload-greater-than) function consists of the **`min`** and **`max`** properties of the given [`min`](#min-min) and [`max`](#max-max) parameters, and they can't be overwritten by the given [`payload`](#payload-payload) parameter of the main function.
{% endhint %}

#### `payload?: Payload`

An optional [`object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) of the generic type variable [`Payload`](#payloadextendsobject-object) is assigned to the [`payload`](https://type.angular-package.dev/type-draft/type/resultcallback#payload-payload) of the given [`callback`](#callback-resultcallback-less-than-type-min-min-max-max-and-payload-greater-than) function.

### Return type

#### `value is NumberBetween<Min, Max, Type>`

The **return type** is a [`boolean`](https://www.typescriptlang.org/docs/handbook/basic-types.html#boolean) as the result of its statement indicating the [`value`](#value-type) is a generic type [`NumberBetween`](https://type.angular-package.dev/type-draft/type/numberbetween) that takes generic type variables [`Min`](#minextendsnumber) and [`Max`](#maxextendsnumber) as a **range** of the supplied [`value`](#value-type) and [`Type`](#typeextendsanynumber) as the **type** of the supplied [`value`](#value-type).

### Returns

The **return value** is a [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) indicating whether the [`value`](#value-type) is a [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) type or an instance of [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) between the specified **range**.

## Example usage

```typescript
// 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
```