Skip to content

docs: fix default stated in setUseStrictIteration JSDoc - #1372

Open
ragib-mrb wants to merge 1 commit into
immerjs:mainfrom
ragib-mrb:strict-iteration-default-docs
Open

ragib-mrb wants to merge 1 commit into
immerjs:mainfrom
ragib-mrb:strict-iteration-default-docs

Conversation

@ragib-mrb

Copy link
Copy Markdown

The JSDoc for setUseStrictIteration says strict iteration is enabled by default, but useStrictIteration_ defaults to false in immerClass.ts, and api.md and performance.mdx already say loose is the default. The class method's comment also says passing false still handles symbols, while loose iteration uses Object.keys and skips them. This updates both comments to match the code, which also fixes the hover text shipped in the .d.ts. Mentioned in #1367.

This branch has not been deployed

No deployments
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.

1 participant