docs: update Object.assign() example to prefer spread operator syntax - #722
Open
eduardbar wants to merge 1 commit into
Open
docs: update Object.assign() example to prefer spread operator syntax#722eduardbar wants to merge 1 commit into
eduardbar wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
The spread operator (...) is the modern, idiomatic way to merge objects
with defaults in JavaScript (ES2018+). The Object.assign() approach,
while still valid, is more verbose and less readable.
Changes:
- Replace Object.assign() in the Good example with object spread syntax
({...defaults, ...config}) which is more concise and widely used today
- Change 'let' to 'const' since finalConfig is not reassigned
- Fix missing semicolon after 'return finalConfig'
- Update the result comment from 'config now equals' to 'finalConfig equals'
to accurately reflect which variable the comment describes
- Add a backward-compatibility note mentioning Object.assign() as an
equivalent alternative for environments without ES2018 spread support
Closes ryanmcdermott#705
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
1 participant
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.
Summary
Updates the "Set default objects with Object.assign" section to showcase the modern object spread operator as the preferred approach, with a backward-compatibility note for older environments.
Motivation
The spread operator ({...defaults, ...config}) has been standard JavaScript (ES2018) for several years and is now supported in all modern browsers and Node.js versions. It is:
Keeping Object.assign() as the primary example in 2024 misleads developers into using a more verbose, less idiomatic API.
Changes
Backward Compatibility Note Added
Closes #705