Skip to content

refactor: replace Object with Record<string, unknown> in ndarray/to-locale-string#12631

Draft
Planeshifter wants to merge 1 commit into
developfrom
philipp/refactor-ndarray-to-locale-string-options-type
Draft

refactor: replace Object with Record<string, unknown> in ndarray/to-locale-string#12631
Planeshifter wants to merge 1 commit into
developfrom
philipp/refactor-ndarray-to-locale-string-options-type

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • replaces the broad Object type for the options parameter of @stdlib/ndarray/to-locale-string with Record<string, unknown>. The function forwards options opaquely to the native Array.prototype.toLocaleString, so a dedicated Options interface is not warranted.

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request?

Found during a TypeScript-declaration audit of the ndarray namespace.

Checklist

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

These changes were identified by a Claude Code audit of the ndarray namespace's TypeScript declarations and applied with Claude Code assistance; the changes were reviewed by myself.


@stdlib-js/reviewers

…/to-locale-string`

The `options` parameter used the broad `Object` anti-pattern. Use
`Record<string, unknown>` instead. The function forwards options opaquely
to the native `toLocaleString`, so a dedicated `Options` interface is not
introduced.

---
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
---
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/to-locale-string $\color{red}327/334$
$\color{green}+97.90\%$
$\color{red}49/54$
$\color{green}+90.74\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{red}327/334$
$\color{green}+97.90\%$

The above coverage report was generated for the changes in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants