Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomokimiyauci/iterange
Numeric sequence lazy generator, TC39 proposal-iterator.range implementation
https://github.com/tomokimiyauci/iterange
generator iterable iterator numeric proposal-iterator-range range sequence tc39
Last synced: 23 days ago
JSON representation
Numeric sequence lazy generator, TC39 proposal-iterator.range implementation
- Host: GitHub
- URL: https://github.com/tomokimiyauci/iterange
- Owner: TomokiMiyauci
- License: mit
- Created: 2023-06-15T16:53:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-21T03:55:08.000Z (over 1 year ago)
- Last Synced: 2024-11-24T20:53:58.413Z (3 months ago)
- Topics: generator, iterable, iterator, numeric, proposal-iterator-range, range, sequence, tc39
- Language: TypeScript
- Homepage: https://deno.land/x/iterange
- Size: 33.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# iterange
[](https://deno.land/x/iterange)
[](https://deno.land/x/iterange/mod.ts)
[](https://github.com/TomokiMiyauci/iterange/releases)
[](https://codecov.io/gh/TomokiMiyauci/iterange)
[](https://github.com/TomokiMiyauci/iterange/blob/main/LICENSE)
[](https://github.com/TomokiMiyauci/iterange/actions/workflows/test.yaml)
[](https://nodei.co/npm/iterange/)
[](https://github.com/RichardLitt/standard-readme)
[](https://github.com/semantic-release/semantic-release)
Numeric sequence lazy generator, TC39
[proposal-iterator.range](https://github.com/tc39/proposal-iterator.range)
implementation.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Incremental sequence](#incremental-sequence)
- [Decremental sequence](#decremental-sequence)
- [Step](#step)
- [Option](#option)
- [Inclusive end](#inclusive-end)
- [Step option](#step-option)
- [Bigint](#bigint)
- [Errors](#errors)
- [Polyfill](#polyfill)
- [API](#api)
- [Contributing](#contributing)
- [License](#license)
## Install
deno.land:
```ts
import * as mod from "https://deno.land/x/iterange/mod.ts";
```
npm:
```bash
npm i iterange
```
## Usage
Show you how to use in this section.
### Incremental sequence
Specify `start` and `end`. By default, `step` is 1 and `end` is exclusive.
```ts
import { range } from "https://deno.land/x/iterange/mod.ts";
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
const start = 0;
const end = 5;
assertEquals([...range(start, end)], [0, 1, 2, 3, 4]);
```
### Decremental sequence
If `end` is less than `start`, a decremental sequence is generated.
```ts
import { range } from "https://deno.land/x/iterange/mod.ts";
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
const iterator = range(1, -3);
assertEquals(iterator.next().value, 1);
assertEquals(iterator.next().value, 0);
assertEquals(iterator.next().value, -1);
```
### Step
You can change the interval(step) of the sequence. The default is `1` (or `1n`
for bigint).
```ts
import { range } from "https://deno.land/x/iterange/mod.ts";
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
const iterator = range(0, Infinity, 2);
assertEquals(iterator.next().value, 0);
assertEquals(iterator.next().value, 2);
assertEquals(iterator.next().value, 4);
```
### Option
The third argument can be one of the following options:
- `inclusive`
- `step`
#### Inclusive end
By default, `end` is exclusive. This can be changed by specifying options.
```ts
import { range } from "https://deno.land/x/iterange/mod.ts";
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
assertEquals([...range(0, 5, { inclusive: true })], [0, 1, 2, 3, 4, 5]);
```
#### Step option
Option accepts another `step` field. This is equivalent to [step](#step).
```ts
import { range } from "https://deno.land/x/iterange/mod.ts";
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
const iterator = range(0, -Infinity, { step: -2 });
assertEquals(iterator.next().value, 0);
assertEquals(iterator.next().value, -2);
assertEquals(iterator.next().value, -4);
```
### Bigint
The range supports `bigint` as well as `number`.
```ts
import { range } from "https://deno.land/x/iterange/mod.ts";
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
const iterator = range(0n, 100n, { step: 10n });
assertEquals(iterator.next().value, 0n);
assertEquals(iterator.next().value, 10n);
assertEquals(iterator.next().value, 20n);
```
That is, the following cannot be compiled and are type safe:
```ts
import { range } from "https://deno.land/x/iterange/mod.ts";
//@ts-expect-error
range(0, 0n);
//@ts-expect-error
range(0, 100, 3n);
//@ts-expect-error
range(1n, Infinity, { step: 1 });
```
### Errors
Throws `RangeError` in the following cases:
- `start`, `end` or `step` is `NaN`
- `start` is infinity
- if `step` is 0, `start` and `end` are not the same
```ts
import { range } from "https://deno.land/x/iterange/mod.ts";
import { assertThrows } from "https://deno.land/std/testing/asserts.ts";
assertThrows(() => range(NaN, 0).next());
assertThrows(() => range(0, NaN).next());
assertThrows(() => range(0, Infinity, NaN).next());
assertThrows(() => range(Infinity, Infinity).next());
assertThrows(() => range(0n, 1n, { step: 0n }).next());
```
### Polyfill
Polyfill affects the global object. You must be very careful when using it.
Depends on the `Iterator` object. If there is no `Iterator`, a runtime error
will occur.
```ts
import "https://deno.land/x/iterange/polyfill.ts";
import { assert } from "https://deno.land/std/testing/asserts.ts";
assert(Iterator.range);
```
## API
See [deno doc](https://deno.land/x/iterange?doc) for all APIs.
## Contributing
See [contributing](CONTRIBUTING.md).
## License
[MIT](LICENSE) © 2023 Tomoki Miyauchi