noEmptyInterface

Ta treść nie jest jeszcze dostępna w Twoim języku.

TypeScript and TSX

Summary

Rule available since: v1.0.0
Diagnostic Category: lint/suspicious/noEmptyInterface
This rule is recommended, which means is enabled by default.
This rule has a safe fix.
The default severity of this rule is error.
Sources:
- Inspired from @typescript-eslint/no-empty-interface

How to configure

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

Description

Disallow the declaration of empty interfaces.

An empty interface in TypeScript does very little: any non-nullable value is assignable to {}. Using an empty interface is often a sign of programmer error, such as misunderstanding the concept of {} or forgetting to fill in fields.

The rule ignores empty interfaces that extends one or multiple types.

Examples

Invalid

1
interface A {}

code-block.ts:1:1 lint/suspicious/noEmptyInterface  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ An empty interface is equivalent to {}.
  
  > 1 │ interface A {}
      │ ^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Safe fix: Use a type alias instead.
  
    1   │ - interface·A·{}
      1 │ + type·A·=·{}
    2 2 │

Valid

1
interface A {
2
  prop: string;
3
}
4

5
// Allow empty interfaces that extend a type.
6
interface B extends A {}
7

8
// Allow empty interfaces in ambient modules
9
declare module "mod" {
10
  interface C {}
11
}