noUnsafeDeclarationMerging

TypeScript and TSX

Summary

Rule available since: v1.0.0
Diagnostic Category: lint/suspicious/noUnsafeDeclarationMerging
This rule is recommended, which means is enabled by default.
This rule doesn’t have a fix.
The default severity of this rule is error.
Sources:
- Same as @typescript-eslint/no-unsafe-declaration-merging

Description

Disallow unsafe declaration merging between interfaces and classes.

TypeScript’s declaration merging supports merging separate declarations with the same name.

Declaration merging between classes and interfaces is unsafe. The TypeScript Compiler doesn’t check whether properties defined in the interface are initialized in the class. This can cause lead to TypeScript not detecting code that will cause runtime errors.

Examples

Invalid

1
interface Foo {
2
    f(): void
3
}
4

5
class Foo {}
6

7
const foo = new Foo();
8
foo.f(); // Runtime Error: Cannot read properties of undefined.

code-block.ts:5:7 lint/suspicious/noUnsafeDeclarationMerging ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This class is unsafely merged with an interface.
  
    3 │ }
    4 │ 
  > 5 │ class Foo {}
      │       ^^^
    6 │ 
    7 │ const foo = new Foo();
  
  ℹ The interface is declared here.
  
  > 1 │ interface Foo {
      │           ^^^
    2 │     f(): void
    3 │ }
  
  ℹ The TypeScript compiler doesn’t check whether properties defined in the interface are initialized in the class.

Valid

1
interface Foo {}
2
class Bar implements Foo {}

1
namespace Baz {}
2
namespace Baz {}
3
enum Baz {}

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noUnsafeDeclarationMerging": "error"
6
      }
7
    }
8
  }
9
}