> For the complete documentation index, see [llms.txt](https://range.angular-package.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://range.angular-package.dev/range/overview.md).

# Overview

The \`Range\` object

## `Range {}`

The `Range` object represents a range between a minimum and maximum.

{% embed url="<https://github.com/angular-package/range/blob/main/src/lib/range.class.ts>" %}
`range.class.ts`
{% endembed %}

### Accessors

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                          |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p><strong>public get</strong> <a href="/range/accessors/get-range.md"><strong>range()</strong></a>: <mark style="color:green;">Readonly</mark><<mark style="color:green;">Array</mark><<mark style="color:green;">number</mark>>><br>The <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get"><code>get</code></a> accessor obtains the range of an <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array"><code>Array</code></a> of the <a href="/range/properties/min.md">minimum</a> to the <a href="/range/properties/max.md">maximum</a> with the <a href="/range/accessors/get-step.md">step</a> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p> |                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public get</strong> <a href="/range/accessors/get-step.md"><strong>step()</strong></a>: <mark style="color:green;">Step</mark><br>The <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get"><code>get</code></a> accessor obtains the step of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public get</strong> <a href="/range/accessors/get-steps.md"><strong>steps()</strong></a>: <mark style="color:green;">number</mark><br>Retrieves the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number"><code>number</code></a> of steps of the specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/accessors/value.md"><strong>value()</strong></a>: <mark style="color:green;">number</mark>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | <mark style="color:green;">undefined</mark><br>The <code>value</code> accessor indicates the range current value of the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a> type of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p> |
| <p><strong>public get</strong> <a href="/range/accessors/get-symbol.tostringtag.md"><strong>[Symbol.</strong><mark style="color:blue;"><strong>toStringTag</strong></mark><strong>](https://range.angular-package.dev/range)</strong></a>: <mark style="color:green;">string</mark><br>The <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get"><code>get</code></a> accessor, with the help of <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag"><code>toStringTag</code></a>, changes the default tag to <code>'Range'</code> for an instance of <a href="/range/overview.md"><code>Range</code></a>.</p>                                                          |                                                                                                                                                                                                                                                                                                                          |

### Properties

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p><strong>public readonly</strong> <a href="/range/properties/max.md"><strong>max!</strong></a>: <mark style="color:green;">Max</mark><br>The <code>max</code> read-only property is the maximum range of generic type variable <a href="/range/generic-type-variables.md#maxextendsnumber"><code>Max</code></a> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                                 |
| <p><strong>public readonly</strong> <a href="/range/properties/min.md"><strong>min!</strong></a>: <mark style="color:green;">Min;</mark><br>The <code>min</code> read-only property is the minimum range of generic type variable <a href="/range/generic-type-variables.md#minextendsnumber"><code>Min</code></a> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                                |
| <p><a href="/range/properties/maximum.md"><strong>#maximum</strong></a>: <mark style="color:green;">Maximum</mark><<mark style="color:green;">Max</mark>><br>Private property of the <a href="/maximum/overview.md"><code>Maximum</code></a> <a href="https://developer.mozilla.org/en-US/docs/Glossary/Primitive#primitive_wrapper_objects_in_javascript">primitive wrapper object</a> with a primitive value from a given <a href="/range/constructor.md#max-max"><code>max</code></a> of the <a href="/range/overview.md"><code>Range</code></a> constructor indicates the maximum range.</p> |
| <p><a href="/range/properties/minimum.md"><strong>#minimum</strong></a>: <mark style="color:green;">Minimum</mark><<mark style="color:green;">Min</mark>><br>Private property of the <a href="/minimum/overview.md"><code>Minimum</code></a> <a href="https://developer.mozilla.org/en-US/docs/Glossary/Primitive#primitive_wrapper_objects_in_javascript">primitive wrapper object</a> with a primitive value from a given <a href="/range/constructor.md#min-min"><code>min</code></a> of the <a href="/range/overview.md"><code>Range</code></a> constructor indicates the minimum range.</p> |
| <p><a href="/range/properties/step.md"><strong>#step</strong></a>: <mark style="color:green;">Step</mark><br>The private property of the generic type variable <a href="/range/generic-type-variables.md#range-less-than-min-max-step-greater-than-2"><code>Step</code></a> indicates the range step.</p>                                                                                                                                                                                                                                                                                        |
| <p><a href="/range/properties/value.md"><strong>#value?</strong></a>: <mark style="color:green;">number</mark><br>The private property of the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number"><code>number</code></a> type indicates the range value.</p>                                                                                                                                                                                                                                                                                      |

### Methods

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><strong>public static</strong> <a href="/range/methods/static-create.md"><strong>create()</strong></a>: <mark style="color:green;">Range</mark><<mark style="color:green;">Value</mark>><br>Returns a new instance of <a href="/range/overview.md"><code>Range</code></a> with a range of the given required <a href="/range/methods/static-create.md#min-min"><code>min</code></a>, <a href="/range/methods/static-create.md#max-max"><code>max</code></a> and optional current <a href="/range/methods/static-create.md#value-number"><code>value</code></a>, <a href="/range/methods/static-create.md#step-step-1-asstep"><code>step</code></a>.</p>                                            |
| <p><strong>public static</strong> <a href="/range/methods/static-createfrom.md"><strong>createFrom()</strong></a>: <mark style="color:green;">Range</mark><<mark style="color:green;">number</mark>, <mark style="color:green;">number</mark>, <mark style="color:green;">Step</mark>><br>Creates the <a href="/range/overview.md"><code>Range</code></a> instance from the given random <a href="/range/methods/static-createfrom.md#numbers-number"><code>numbers</code></a> and the <a href="/range/methods/static-createfrom.md#step-step"><code>step</code></a>.</p>                                                                                                                             |
| <p><strong>public static</strong> <a href="/range/methods/static-createminimum.md"><strong>createMaximum()</strong></a>: <mark style="color:green;">Maximum</mark><<mark style="color:green;">Value</mark>><br>Returns the <a href="/maximum/overview.md"><code>Maximum</code></a> instance of the given <strong>maximum</strong> <a href="/range/methods/static-createmaximum.md#value-value"><code>value</code></a>.</p>                                                                                                                                                                                                                                                                            |
| <p><strong>public static</strong> <a href="/range/methods/static-createminimum.md"><strong>createMinimum()</strong></a>: <mark style="color:green;">Minimum</mark><<mark style="color:green;">Value</mark>><br>Returns the <a href="/minimum/overview.md"><code>Minimum</code></a> instance of the given <strong>minimum</strong> <a href="/range/methods/static-createminimum.md#value-value"><code>value</code></a>.</p>                                                                                                                                                                                                                                                                            |
| <p><strong>public static</strong> <a href="/range/methods/static-isrange.md"><strong>isRange()</strong></a>: value is <mark style="color:green;">Range</mark><<mark style="color:green;">Min</mark>, <mark style="color:green;">Max</mark>><br>Checks whether the <a href="/range/methods/static-isrange.md#value-any"><code>value</code></a> is an instance of <a href="/range/overview.md"><code>Range</code></a> of any or the given <a href="/range/methods/static-isrange.md#min-min"><strong>minimum</strong></a> and <a href="/range/methods/static-isrange.md#max-max"><strong>maximum</strong></a> range and <a href="/range/methods/static-isrange.md#step-step"><code>step</code></a>.</p> |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                          |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><strong>public</strong> <a href="/range/methods/foreachstep.md"><strong>forEachStep()</strong></a>: <mark style="color:green;">this</mark><br>Performs the specified action for each step in the <a href="/range/properties/max.md">maximum</a> range of an <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array"><code>Array</code></a>.</p>                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/getcurrentrange.md"><strong>getCurrentRange()</strong></a>: <mark style="color:green;">Readonly</mark><<mark style="color:green;">Array</mark><<mark style="color:green;">number</mark>>>                                                                                                                                                                                                                                                                                                          | <mark style="color:green;">undefined</mark><br>Returns a range of numbers from <a href="/range/properties/min.md">minimum</a> to the current <a href="/range/accessors/value.md">value</a> by the <a href="/range/accessors/get-step.md"><code>step</code></a> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                            |
| <p><strong>public</strong> <a href="/range/methods/getcurrentstep.md"><strong>getCurrentStep()</strong></a>: <mark style="color:green;">number</mark>                                                                                                                                                                                                                                                                                                                                                                                                 | <mark style="color:green;">undefined</mark><br>Returns the step of the range <a href="/range/accessors/value.md">value</a>.</p>                                                                                                                                                                                                                                                          |
| <p><a href="/general-concepts.md#undefined"><mark style="color:red;">⚠</mark></a> <strong>public</strong> <a href="/range/methods/getmax.md"><strong>getMax()</strong></a>: <mark style="color:green;">Max</mark><br>Gets the <strong>maximum</strong> range of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><a href="/general-concepts.md#undefined"><mark style="color:red;">⚠</mark></a> <strong>public</strong> <a href="/range/methods/getmin.md"><strong>getMin()</strong></a>: <mark style="color:green;">Min</mark><br>Gets the <strong>minimum</strong> range of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/getrange.md"><strong>getRange()</strong></a>: <mark style="color:green;">number</mark>\[]<br>Returns range of numbers from <a href="/range/properties/min.md">minimum</a> to the given <a href="/pages/dXvAlbtLbzaj3w9i2tZv#value-number-this.max"><code>value</code></a> with the <a href="/range/accessors/get-step.md"><code>step</code></a> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                     |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/getrangeofstep.md"><strong>getRangeOfStep()</strong></a>: <mark style="color:green;">Readonly</mark><<mark style="color:green;">Array</mark><<mark style="color:green;">number</mark>>>                                                                                                                                                                                                                                                                                                            | <mark style="color:green;">undefined</mark><br>Returns a range of numbers by the specified <a href="/range/accessors/get-step.md"><code>step</code></a> from the <a href="/range/properties/min.md">minimum</a> to the given <a href="/range/methods/getrangeofstep.md#step-number"><code>step</code></a> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p> |
| <p><strong>public</strong> <a href="/range/methods/getvalueofstep.md"><strong>getValueOfStep()</strong></a>: <mark style="color:green;">number</mark>                                                                                                                                                                                                                                                                                                                                                                                                 | <mark style="color:green;">undefined</mark><br>Returns the range value of the given <a href="/range/methods/getvalueofstep.md#step-number"><code>step</code></a>.</p>                                                                                                                                                                                                                    |
| <p><strong>public</strong> <a href="/range/methods/has.md"><strong>has()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether the <a href="/range/methods/has.md#value-number"><code>value</code></a> is in the range of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/hasevery.md"><strong>hasEvery()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether every value of the given <a href="/pages/RBfEX2Ue9lGCEUX8HgIp#...values-number"><code>values</code></a> is in the range of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/hassome.md"><strong>hasSome()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether some <a href="/pages/btdZ4Qh7QdlmIZWnmXrN#...values-number"><code>values</code></a> are in the range of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/isbetween.md"><strong>isBetween()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether range of the given <a href="/range/methods/isbetween.md#min-number"><code>min</code></a> and <a href="/range/methods/isbetween.md#max-number"><code>max</code></a> is between the range of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/isbetweenevery.md"><strong>isBetweenEvery()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether the range of a specified <a href="/range/overview.md"><code>Range</code></a> object is between every range of the given <a href="/pages/xUAw8v9sZBu77tIqcfOA#...ranges-number-number"><code>ranges</code></a>.</p>                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/isbetweensome.md"><strong>isBetweenSome()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether the range of a specified <a href="/range/overview.md"><code>Range</code></a> object is between <strong>some</strong> given <a href="/pages/MoZjsKLwzky7aZw9h2qv#...ranges-number-number"><code>ranges</code></a>.</p>                                                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/maxgreaterthan.md"><strong>maxGreaterThan()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether the <a href="/range/methods/maxgreaterthan.md#value-number"><code>value</code></a> is <strong>less</strong> than the <a href="/range/properties/max.md"><strong>maximum</strong></a> <strong>range</strong> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/maxlessthan.md"><strong>maxLessThan()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether the <a href="/range/methods/maxlessthan.md#value-number"><code>value</code></a> is greater than the <a href="/range/properties/max.md"><strong>maximum</strong></a> <strong>range</strong> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/mingreaterthan.md"><strong>minGreaterThan()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether the <a href="/range/methods/mingreaterthan.md#value-number"><code>value</code></a> is <strong>less</strong> than a <a href="/range/properties/min.md"><strong>minimum</strong></a> <strong>range</strong> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                     |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/minlessthan.md"><strong>minLessThan()</strong></a>: <mark style="color:green;">boolean</mark><br>Checks whether the <a href="/range/methods/minlessthan.md#value-number"><code>value</code></a> is greater than the <a href="/range/properties/min.md"><strong>minimum</strong></a> <strong>range</strong> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/setvalue.md"><strong>setValue()</strong></a>: <mark style="color:green;">this</mark><br>Sets the range <a href="/range/accessors/value.md"><code>value</code></a> between the <a href="/range/properties/min.md">minimum</a> and <a href="/pages/axyOCaYA3ZNCNCFu5va6#range.prototype.max">maximum</a> of a specified <a href="/range/overview.md"><code>Range</code></a> object.</p>                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/setvaluetostep.md"><strong>setValueToStep()</strong></a>: <mark style="color:green;">this</mark><br>Sets the <a href="/range/accessors/value.md"><code>value</code></a> of the specified <a href="/range/overview.md"><code>Range</code></a> object to the value of the given <a href="/range/methods/setvaluetostep.md#step-number"><code>step</code></a>.</p>                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><strong>public</strong> <a href="/range/methods/stepbystep.md"><strong>stepByStep()</strong></a>: <mark style="color:green;">this</mark><br>Performs a callback function with the ability to decide when to move to the next step of the range.</p>                                                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><a href="/general-concepts.md#undefined"><mark style="color:red;">⚠</mark></a> <strong>public</strong> <a href="/range/methods/toarray.md"><strong>toArray()</strong></a>: readonly \[<mark style="color:green;">Min</mark>, <mark style="color:green;">Max</mark>]<br>Returns a read-only array of the range in order minimum and maximum.</p>                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><a href="/general-concepts.md#undefined"><mark style="color:red;">⚠</mark></a> <strong>public</strong> <a href="/pages/pAvLgk7tvMGKtjf2J13G#range.prototype.valueof"><strong>valueOf()</strong></a>: <mark style="color:green;">Readonly</mark><{ min: <mark style="color:green;">Min</mark>; max: <mark style="color:green;">Max</mark> }><br>Returns a read-only object consisting of the primitive values of <a href="/minimum/overview.md"><code>Minimum</code></a> and <a href="/maximum/overview.md"><code>Maximum</code></a> instances.</p> |                                                                                                                                                                                                                                                                                                                                                                                          |
