Skip to content

Changed Function arguments section to include destructuring #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanmcdermott merged 1 commit into from
Jan 21, 2017
Merged

Changed Function arguments section to include destructuring #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,17 @@ Since JavaScript allows us to make objects on the fly, without a lot of class
boilerplate, you can use an object if you are finding yourself needing a
lot of arguments.

To make it more obvious what properties does the function expect, use the es6
destructuring syntax. This has a couple of advantages:

1. When someone looks at the function signature, it's immediately clear what
properties are used.
2. Since the function doesn't have the reference to the actual argument, the
user of the function can be sure that no other properties are used by anything
down the call chain.
3. Linters (like eslint) can warn you about unused properties, while this would
be impossible without destructuring.

**Bad:**
```javascript
function createMenu(title, body, buttonText, cancellable) {
Expand All @@ -221,7 +232,7 @@ function createMenu(title, body, buttonText, cancellable) {

**Good:**
```javascript
function createMenu(config) {
function createMenu({ title, body, buttonText, cancellable }) {
// ...
}

Expand Down