# setValueToStep()

## `Range.prototype.setValueToStep()`

The method `setValueToStep()` sets the [value](https://range.angular-package.dev/accessors/value#range.prototype.value) of the specified [`Range`](https://range.angular-package.dev/range) object to the value of the given [`step`](#step-number).

{% hint style="warning" %}
If the given [`step`](#step-number) is not within range the [`value`](https://range.angular-package.dev/range/accessors/value) is not changed.
{% endhint %}

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

```typescript
public setValueToStep(step: number): this {
  step > 0 && (this.value = this.getValueOfStep(step));
  return this;
}
```

{% endcode %}

### Parameters

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

Step of [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) type to retrieve the value from the range and set it as the range current [`value`](https://range.angular-package.dev/range/accessors/value).

### Return type

#### [<mark style="color:green;">`this`</mark>](https://range.angular-package.dev/range)

### Returns

The **return value** is the [`Range`](https://range.angular-package.dev/range) instance.

## Example usage

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

// Create new instance.
// Returns Range {min: 3, max: 27, value: 10} of Range<3, 27, 3>.
const range = new Range(3, 27, 10, 3);

// Cannot assign to 'value' because it is a read-only property.ts(2540)
// range.value = 12;

// Returns 9 of type number | undefined.
range.setValueToStep(3).value;

// Returns 27 of type number | undefined.
range.setValueToStep(9).value;

// Returns undefined of type number | undefined.
range.setValueToStep(11).value;
```