func-named-parameters.md

warning	layout	title
This is a dynamically generated file. Do not edit manually.	default	func-named-parameters | Solhint

func-named-parameters

Description

Enforce named parameters for function calls with 4 or more arguments. This rule may have some false positives

Options

This rule accepts an array of options:

Index	Description	Default Value
0	Rule severity. Must be one of "error", "warn", "off".	warn
1	Minimum qty of unnamed parameters for a function call (to prevent false positives on builtin functions).	4

Example Config

{
  "rules": {
    "func-named-parameters": ["warn",4]
  }
}

Examples

👍 Examples of correct code for this rule

Function call with two UNNAMED parameters (default is 4)

functionName('0xA81705c8C247C413a19A244938ae7f4A0393944e', 1e18)

Function call with two NAMED parameters

functionName({ sender: '0xA81705c8C247C413a19A244938ae7f4A0393944e', amount: 1e18})

Function call with four NAMED parameters

functionName({ sender: _senderAddress, amount: 1e18, token: _tokenAddress, receiver: _receiverAddress })

abi.encodeX call with four UNNAMED parameters

abi.encodePacked(_senderAddress, 1e18, _tokenAddress, _receiverAddress )

👎 Examples of incorrect code for this rule

Function call with four UNNAMED parameters (default 4)

functionName(_senderAddress, 1e18, _tokenAddress, _receiverAddress )

Version

This rule was introduced in Solhint 3.5.1

Resources

• Rule source
• Document source
• Test cases