@hugoalh/range-iterator

An ECMAScript (JavaScript & TypeScript) module to iterate between range.

https://github.com/hugoalh/range-iterator-es

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (7.9%) to scientific vocabulary

Keywords

ecmascript ecmascript-module es es-module esm esmodule iterate iterator javascript js range ts typescript

Last synced: 4 months ago · JSON representation ·

Repository

An ECMAScript (JavaScript & TypeScript) module to iterate between range.

Basic Info

Host: GitHub
Owner: hugoalh
License: other
Language: TypeScript
Default Branch: main
Homepage:
Size: 154 KB

Statistics

Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 13

Topics

ecmascript ecmascript-module es es-module esm esmodule iterate iterator javascript js range ts typescript

Created over 2 years ago · Last pushed 4 months ago

Metadata Files

Readme Contributing License Citation Codeowners Security

README.md

Range Iterator (ES)

⚖️ MIT

An ECMAScript (JavaScript & TypeScript) module to iterate between range.

🔰 Begin

🎯 Targets

| Targets | Remote | JSR | NPM | |:--|:-:|:-:|:-:| | Bun >= v1.1.0 | ❌ | ✔️ | ✔️ | | Deno >= v2.1.0 | ✔️ | ✔️ | ✔️ | | NodeJS >= v20.9.0 | ❌ | ✔️ | ✔️ |

[!NOTE] - It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.

#️⃣ Resources Identifier

Remote - GitHub Raw: https://raw.githubusercontent.com/hugoalh/range-iterator-es/{Tag}/mod.ts
JSR: [jsr:]@hugoalh/range-iterator[@{Tag}]
NPM: [npm:]@hugoalh/range-iterator[@{Tag}]

[!NOTE] - For usage of remote resources, it is recommended to import the entire module with the main path mod.ts, however it is also able to import part of the module with sub path if available, but do not import if:

it's path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or

it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or

it's symbol has an underscore prefix (e.g.: _bar, _foo).

These elements are not considered part of the public API, thus no stability is guaranteed for them. - For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the file jsr.jsonc property exports for available sub entrypoints. - It is recommended to use this module with tag for immutability.

🛡️ Runtime Permissions

This module does not request any runtime permission.

🧩 APIs

ts function rangeIterator(start: bigint, end: bigint, options?: RangeIteratorOptions<bigint>): Generator<bigint>; function rangeIterator(start: bigint, end: bigint, step: bigint): Generator<bigint>; function rangeIterator(start: number, end: number, options?: RangeIteratorOptions<number>): Generator<number>; function rangeIterator(start: number, end: number, step: number): Generator<number>; function rangeIterator(start: string, end: string, options?: RangeIteratorOptions<string>): Generator<string>; function rangeIterator(start: string, end: string, step: number): Generator<string>;
ts interface RangeIteratorOptions<T extends bigint | number | string> { excludeEnd?: boolean; excludes?: readonly T[] | Set<T>; excludeStart?: boolean; step?: T extends string ? number : T; }

[!NOTE] - For the full or prettier documentation, can visit via: - Deno CLI deno doc - JSR

✍️ Examples

ts Array.from(rangeIterator(1, 9)); //=> [1, 2, 3, 4, 5, 6, 7, 8, 9]
ts Array.from(rangeIterator(1n, 9n, { excludeEnd: true })); //=> [1n, 2n, 3n, 4n, 5n, 6n, 7n, 8n]
ts Array.from(rangeIterator(1, 9, { step: 0.5 })); //=> [1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 5.5, 6, 6.5, 7, 7.5, 8, 8.5, 9]
ts Array.from(rangeIterator("a", "z")); //=> ["a", "b", "c", ... +20 ..., "x", "y", "z"]
ts Array.from(rangeIterator(9, 1)); //=> [9, 8, 7, 6, 5, 4, 3, 2, 1]
ts Array.from(rangeIterator(9n, 1n, { excludeEnd: true })); //=> [9n, 8n, 7n, 6n, 5n, 4n, 3n, 2n]
ts Array.from(rangeIterator(9, 1, { step: 0.5 })); //=> [9, 8.5, 8, 7.5, 7, 6.5, 6, 5.5, 5, 4.5, 4, 3.5, 3, 2.5, 2, 1.5, 1]
ts Array.from(rangeIterator("z", "a")); //=> ["z", "y", "x", ... +20 ..., "c", "b", "a"]

Owner

Name: hugoalh
Login: hugoalh
Kind: user
Location: Everywhere
Company: @hugoalh-studio

Twitter: hugoalhofficial
Repositories: 12
Profile: https://github.com/hugoalh

Lead of @hugoalh-studio; Full time software developer; Part time freelancer

Citation (CITATION.cff)

# yaml-language-server: $schema=https://citation-file-format.github.io/1.2.0/schema.json
cff-version: "1.2.0"
title: "Range Iterator (ES)"
message: "If you use this software, please cite it using the metadata from this file."
type: "software"
authors:
  - name: "hugoalh"
repository-code: "https://github.com/hugoalh/range-iterator-es"
keywords:
  - "ecmascript"
  - "ecmascript-module"
  - "es"
  - "es-module"
  - "esm"
  - "esmodule"
  - "iterate"
  - "iterator"
  - "javascript"
  - "js"
  - "range"
  - "ts"
  - "typescript"
license: "MIT"

GitHub Events

Total

Create event: 5
Issues event: 1
Release event: 3
Watch event: 1
Delete event: 7
Issue comment event: 1
Push event: 26
Pull request event: 6
Pull request review event: 4

Last Year

Create event: 5
Issues event: 1
Release event: 3
Watch event: 1
Delete event: 7
Issue comment event: 1
Push event: 26
Pull request event: 6
Pull request review event: 4

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 1
Total pull requests: 21
Average time to close issues: N/A
Average time to close pull requests: 4 days
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 0.52
Merged pull requests: 10
Bot issues: 0
Bot pull requests: 21

Past Year

Issues: 1
Pull requests: 20
Average time to close issues: N/A
Average time to close pull requests: 4 days
Issue authors: 1
Pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 0.5
Merged pull requests: 10
Bot issues: 0
Bot pull requests: 20

View more stats

Top Authors

Issue Authors

hugoalh (1)

Pull Request Authors

dependabot[bot] (25)

Top Labels

Issue Labels

Priority/Low 🟢 (1) Type/Documentation 📓 (1) Platform/DenoNetwork (1)

Pull Request Labels

Platform/GitHubActions (24) Type/Dependency 📦 (24) Priority/Low 🟢 (14) Status/Pending 🔵 (10) github-actions (1) dependency 📦 (1)

Packages

Total packages: 2
Total downloads:
- npm 114 last-month

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 0
(may contain duplicates)
Total versions: 21
Total maintainers: 1

deno.land: range_iterator

An ES (JavaScript & TypeScript) module to iterate between range.

Documentation: https://doc.deno.land/https://deno.land/x/range_iterator/mod.ts
License: other
Latest release: v2.1.0
published about 1 year ago

Versions: 11
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Average: 27.2%

Dependent packages count: 54.5%

Last synced: 4 months ago

npmjs.org: @hugoalh/range-iterator

A module to iterate between range.

Homepage: https://github.com/hugoalh/range-iterator-es#readme
License: MIT
Latest release: 3.0.0
published 5 months ago

Versions: 10
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 114 Last month

Rankings

Forks count: 15.9%

Stargazers count: 17.3%

Average: 31.0%

Dependent repos count: 37.3%

Dependent packages count: 53.4%

Maintainers (1)

hugoalh

Last synced: 4 months ago