---
description: 'Require destructuring from arrays and/or objects.'
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/prefer-destructuring** for documentation.

## Examples

This rule extends the base [`eslint/prefer-destructuring`](https://eslint.org/docs/latest/rules/prefer-destructuring) rule.
It adds support for TypeScript's type annotations in variable declarations.

<Tabs>

<TabItem value="`eslint/prefer-destructuring`">

```ts
const x: string = obj.x; // This is incorrect and the auto fixer provides following untyped fix.
// const { x } = obj;
```

</TabItem>
<TabItem value="`@typescript-eslint/prefer-destructuring`">

```ts
const x: string = obj.x; // This is correct by default. You can also forbid this by an option.
```

</TabItem>
</Tabs>

And it infers binding patterns more accurately thanks to the type checker.

<Tabs>
<TabItem value="❌ Incorrect">

```ts
const x = ['a'];
const y = x[0];
```

</TabItem>
<TabItem value="✅ Correct">

```ts
const x = { 0: 'a' };
const y = x[0];
```

It is correct when `enforceForRenamedProperties` is not true.
Valid destructuring syntax is renamed style like `{ 0: y } = x` rather than `[y] = x` because `x` is not iterable.

</TabItem>
</Tabs>

## Options

This rule adds the following options:

```ts
type Options = [
  BasePreferDestructuringOptions[0],
  BasePreferDestructuringOptions[1] & {
    enforceForDeclarationWithTypeAnnotation?: boolean;
  },
];

const defaultOptions: Options = [
  basePreferDestructuringDefaultOptions[0],
  {
    ...basePreferDestructuringDefaultOptions[1],
    enforceForDeclarationWithTypeAnnotation: false,
  },
];
```

### `enforceForDeclarationWithTypeAnnotation`

When set to `true`, type annotated variable declarations are enforced to use destructuring assignment.

Examples with `{ enforceForDeclarationWithTypeAnnotation: true }`:

<Tabs>
<TabItem value="❌ Incorrect">

```ts
const x: string = obj.x;
```

</TabItem>
<TabItem value="✅ Correct">

```ts
const { x }: { x: string } = obj;
```

</TabItem>
</Tabs>
