# static isMaximum()

## `Maximum.isMaximum()`

Checks whether the value of [`any`](https://www.typescriptlang.org/docs/handbook/basic-types.html#any) type is the [`Maximum`](https://docs.angular-package.dev/range-1/maximum) instance of any or the given primitive [value](#max-value).

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

```typescript
public static isMaximum<Value extends number>(
  value: any,
  max?: Value
): value is Maximum<Value> {
  return (
    typeof value === 'object' &&
    value instanceof this &&
    (typeof max === 'number' ? value.valueOf() === max : 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 [`max`](#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 [`Maximum`](https://docs.angular-package.dev/range-1/maximum) instance.

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

Optional maximum of the generic type variable [`Value`](#valueextendsnumber) to check if it's the primitive value of the given [`value`](#value-any).

### Return type

#### `value is Maximum<`[<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 [`Maximum`](https://docs.angular-package.dev/range-1/maximum) 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 is an instance of [`Maximum`](https://docs.angular-package.dev/range-1/maximum).

### Example usage

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


```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.angular-package.dev/range-1/maximum/methods/static-ismaximum.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.