Skip to main content

No Destructuring

Disallow destructuring patterns to encourage descriptive parameter names and explicit property access.

Summary

The no-destructuring rule reports destructuring patterns in five contexts:

  • Callback parameters.
  • for...of loops.
  • Standalone function parameters.
  • Variable declarations.
  • Assignment expressions.

Each check can be independently toggled.

Why Use This Rule?

  1. Encourages descriptive parameter names that convey the whole object's role.
  2. Makes property access explicit so readers can trace where each value comes from.
  3. Keeps callback bodies readable with named intermediate constants.

Examples

Configuration

Options

warning

ignoreFiles is an escape hatch for files where this rule genuinely does not apply. It is not intended for routine use.

OptionTypeDefaultDescription
assignmentExpressionsbooleantrueBan destructuring in assignment expressions.
callbackParamsbooleantrueBan destructuring in callback parameters of these array methods only: map, filter, find, forEach, some, every, reduce, flatMap, sort, findIndex, findLast, findLastIndex. Callbacks to other methods are not covered by this check.
forOfLoopsbooleantrueBan destructuring in for...of loops.
functionParamsbooleantrueBan destructuring in standalone function/method parameters.
ignoreFilesstring[][]File names to skip. Supports a leading-* suffix (*.test.ts), an exact path, or a trailing path segment; ** globs are not supported.
variableDeclarationsbooleantrueBan destructuring in const/let/var declarations.

Autofix

Autofix is not available for this rule. Flagged code must be updated manually.

Troubleshooting

  • Warning fires on Object.entries() destructuring — The forOfLoops check applies to all for...of destructuring. Access entries by index instead, or set forOfLoops: false.
  • Want to allow destructuring in variable declarations only — Set variableDeclarations: false while keeping the other checks enabled.
  • Destructuring in a callback to a non-array-method (e.g. .then(), .addEventListener(), a custom function) is not flagged — callbackParams only covers a fixed list of array methods, and functionParams deliberately skips any function passed as a call argument. There is currently no option that flags these.