javascript/typescript - force to pass object as function argument by eslint rule

Question

Is it possible to force the following rule by eslint?

if the number of function arguments is more than one, use "object" as an argument.

For example,

good
- const f = (x: string) => ...
- const f = (x: {id: string}) => ...
- const f = (x: {id: string; name: string}) => ...
bad
- const f= (x: string; y: string) => ...

I checked the official document ( https://eslint.org/docs/rules/ ), but I couldn't find appropriate rules. I wonder if some kind of custom rules can realize this.

vighnesh153 · Accepted Answer · 2022-01-27 05:54:56Z

3

You can use max-params rule. https://eslint.org/docs/rules/max-params Set the max value to 1.

answered Jan 27, 2022 at 5:54

vighnesh153

5,5103 gold badges26 silver badges46 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Matthew Goodwin Over a year ago

When I try this, I start getting errors for accessing the parameters of prototype functions like .map(item, index) etc. Is there no way to only have it target function declarations??

vighnesh153 Over a year ago

Technically, there is no function declaration in JavaScript; both are function definitions. I think you meant to disable it for callbacks. The closest thing I could find was this GitHub issue: github.com/eslint/eslint/issues/9562#issuecomment-353753269. In this issue, it is mentioned that you can extend this eslint rule and filter out the pointers to callbacks.

Collectives™ on Stack Overflow

javascript/typescript - force to pass object as function argument by eslint rule

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related