refactor: use shared Iterator type in iter/cugmean#12497
Draft
Planeshifter wants to merge 1 commit into
Draft
Conversation
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown_pkg_readmes
status: na
- task: lint_markdown_docs
status: na
- task: lint_markdown
status: na
- task: lint_package_json
status: na
- task: lint_repl_help
status: na
- task: lint_javascript_src
status: na
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: na
- task: lint_javascript_tests
status: na
- task: lint_javascript_benchmarks
status: na
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: passed
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
reviewed
Jun 3, 2026
| @@ -20,10 +20,7 @@ | |||
|
|
|||
| /// <reference types="@stdlib/types"/> | |||
|
|
|||
| import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter'; | |||
Member
There was a problem hiding this comment.
This isn't quite what we want. We can actually improve type specificity here and in other similar packages in a few ways:
- The union is correct insofar as the function accepts both iterators and iterable iterators.
- The output iterator should be typed, as it always returns numbers.
- We should likely type the input iterator, as well, since it should return numbers.
- Via the union, we can use generics where
Textends the union and we returnT. That should cover both the iterator and iterable iterator behavior mentioned in the notes for those environments supportingSymbol.iterator.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request replaces the local Iterator union type (Iter or IterableIterator) with the direct import { Iterator } from "@stdlib/types/iter" used by all eight sibling iter/cu*mean packages (e.g. cumean), which share an identical declaration shape and type test.
This is part of a series of follow-up PRs addressing findings from a TypeScript declaration audit of the
statsnamespace (documentation-only fixes landed separately in #12482).Related Issues
No.
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This change was surfaced by a Claude Code audit of the
statsnamespace TypeScript declarations. The fix was verified against the implementation and declaration test before submission, and reviewed by myself.@stdlib-js/reviewers