Darkhogg/polyethylene

View on GitHub
docs/polyethylene.poly.range_2.md

Summary

Maintainability
Test Coverage
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [polyethylene](./polyethylene.md) &gt; [Poly](./polyethylene.poly.md) &gt; [range](./polyethylene.poly.range_2.md)

## Poly.range() function

Returns a [PolySyncIterable](./polyethylene.polysynciterable.md) that yields numbers from `from` up to, but not including, `to`<!-- -->, with a step of `step`<!-- -->.

<b>Signature:</b>

```typescript
function range(from: number, to: number, step?: number): PolySyncIterable<number>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  from | number | Inclusive lower bound of the iteration |
|  to | number | Exclusive upper bound of the iteration |
|  step | number | Distance between the iterated numbers |

<b>Returns:</b>

PolySyncIterable&lt;number&gt;

- An iterable over the numbers from `from` to `to` with a step of `step`