Class Range

A half-open integer range.

This should be constructed with RangeFrom.prototype.to.

Implements

ReverseSizedIterable<number>

Index

Constructors

Methods

[iterableSize] [iterator] [reverseIterator] from to toInclusive

Constructors

constructor

new Range(start: number, end: number, step: number): Range
Parameters
- start: number
- end: number
- step: number
Returns Range
- Defined in src/range.ts:120

Methods

[iterableSize]

"[iterableSize]"(): number
Returns the exact count of items in the iterable.

Returns number
Implementation of ReverseSizedIterable.[iterableSize]
- Defined in src/range.ts:134

[iterator]

"[iterator]"(): Iterator<number>
Returns Iterator<number>
Implementation of ReverseSizedIterable.[iterator]
- Defined in src/range.ts:126

[reverseIterator]

"[reverseIterator]"(): Iterator<number>
Creates the reverse iterator for this iterable.

Returns Iterator<number>
Implementation of ReverseSizedIterable.[reverseIterator]
- Defined in src/range.ts:130

`Static`from

from(start?: number): RangeFrom
Creates an infinite range [start,∞).
Parameters
- start: number = 0
  start for the range
Returns RangeFrom
- Defined in src/range.ts:143

`Static`to

to(end: number, step?: number): Range
Creates an integer half-open range [0,end), optionally with a step.
Parameters
- end: number
  end for the range
- step: number = 1
Returns Range
- Defined in src/range.ts:152

`Static`toInclusive

toInclusive(end: number, step?: number): Range
Creates an integer closed range [0,end], optionally with a step.
Parameters
- end: number
  end for the range
- step: number = 1
Returns Range
- Defined in src/range.ts:161