# static isMinimum()

## `Minimum.isMinimum()`

The static `isMinimum()` method checks the provided [`value`](#value-any) of [`any`](https://www.typescriptlang.org/docs/handbook/basic-types.html#any) type whether is an instance of [`Minimum`](https://docs.angular-package.dev/range-1/minimum) of any or the given [`min`](#min-value).

{% code title="minimum.class.ts" %}

```typescript
public static isMinimum<Value extends number>(
  value: any,
  min?: Value
): value is Minimum<Value> {
  return (
    typeof value === 'object' &&
    value instanceof this &&
    (typeof min === 'number' ? value.valueOf() : true)
  );
}
```

{% endcode %}

### Generic type variables

#### <mark style="color:green;">`Value`</mark>`extends`[<mark style="color:green;">`number`</mark>](https://www.typescriptlang.org/docs/handbook/basic-types.html#number)

A generic type variable indicates captured type of the supplied [`min`](#max-value) via the [return type](#return-type).

### Parameters

#### `value:`[<mark style="color:green;">`any`</mark>](https://www.typescriptlang.org/docs/handbook/basic-types.html#any)

The value of [`any`](https://www.typescriptlang.org/docs/handbook/basic-types.html#any) type to test against the [`Minimum`](https://docs.angular-package.dev/range-1/minimum) instance.

#### `min?:`[<mark style="color:green;">`Value`</mark>](#valueextendsnumber)

Optional minimum of the generic type variable [`Value`](#valueextendsnumber) to check if it's the [primitive value](https://docs.angular-package.dev/range-1/minimum/valueof#minimum.prototype.valueof) of the given [`value`](#value-any).

### Return type

#### `value is Minimum<`[<mark style="color:green;">`Value`</mark>](#valueextendsnumber)`>`

The **return type** is a [`boolean`](https://www.typescriptlang.org/docs/handbook/basic-types.html#boolean) resulting from its statement indicating the [`value`](#value-any) is the [`Minimum`](https://docs.angular-package.dev/range-1/minimum) object that takes the generic type variable [`Value`](#valueextendsnumber).

### Returns

The **return value** is a [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) indicating whether the provided [`value`](#value-any) is an instance of [`Minimum`](https://docs.angular-package.dev/range-1/minimum) of any or the given [`min`](#min-value).

## Example usage

```typescript
// Example usage.
import { Minimum } from '@angular-package/range';


```