fix: broaden parameter types in @stdlib/assert/is-negative-finite#12450
Open
Planeshifter wants to merge 1 commit into
Open
fix: broaden parameter types in @stdlib/assert/is-negative-finite#12450Planeshifter wants to merge 1 commit into
@stdlib/assert/is-negative-finite#12450Planeshifter wants to merge 1 commit into
Conversation
Type the `value` parameter of the call signature, `isPrimitive`, and
`isObject` as `any` instead of `number | Number`, matching the sibling
finite/number predicates (`is-positive-finite`, `is-nonnegative-finite`,
`is-nonpositive-finite`, `is-negative-number`). The narrow type rejected
legitimate inputs documented by the package's own examples (e.g.
`isNegativeFinite( null )`).
Additionally:
- Rename the interface `isNegativeFinite` -> `IsNegativeFinite`
(PascalCase) to match all sibling declarations, and update the
`declare var` annotation.
- Correct the top-level summary "Tests if a value is a negative
number." -> "Tests if a value is a finite negative number."
(copy-paste from `is-negative-number`) and the `isObject` summary to
include "finite".
---
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. |
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
2 participants
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:
valueparameter type in the@stdlib/assert/is-negative-finiteTypeScript declaration fromnumber | Numbertoany, matching the sibling finite/number predicates (is-positive-finite,is-nonnegative-finite,is-nonpositive-finite,is-negative-number). The narrow type rejected legitimate inputs documented by the package's own examples (e.g.isNegativeFinite( null )).isNegativeFinitetoIsNegativeFinite(PascalCase), matching all sibling declarations.is-negative-number) and theisObjectsummary to include "finite".Related Issues
No.
Questions
No.
Other
Identified via a TypeScript-declaration audit of the
@stdlib/assertnamespace. Documentation-only wording fixes for other packages are submitted separately.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored primarily by Claude Code (Anthropic's CLI), which audited the
@stdlib/assertTypeScript declarations and proposed and applied the fix. I reviewed the changes.@stdlib-js/reviewers