noMisleadingInstantiator

此内容尚不支持你的语言。

TypeScript and TSX

Summary

Rule available since: v1.3.0
Diagnostic Category: lint/suspicious/noMisleadingInstantiator
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-misused-new

How to configure

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

Description

Enforce proper usage of new and constructor.

In JavaScript, classes utilize the constructor method to initialize a new instance. On the other hand, TypeScript interfaces can describe a class type with a new() method signature, though this pattern is not commonly seen in real-world code. Developers, especially those new to JavaScript or TypeScript, might occasionally confuse the use of constructor with new. This rule triggers warnings in the following scenarios:

When a class has a method named new.
When an interface defines a method named constructor or new that returns the interface type.
When a type alias has a constructor method.

You should not use this rule if you intentionally want a class with a new method, and you’re confident nobody working in your code will mistake it with an constructor.

Examples

Invalid

1
interface I {
2
  new (): I;
3
  constructor(): void;
4
}

code-block.ts:2:3 lint/suspicious/noMisleadingInstantiator ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Don’t use the new method in interfaces.
  
    1 │ interface I {
  > 2 │   new (): I;
      │   ^^^^^^^^^^
    3 │   constructor(): void;
    4 │ }
  
  ℹ new in an interface suggests it’s instantiable, which is incorrect. The returned type should different from the constructor’s type.

1
class C {
2
  new(): C;
3
}

code-block.ts:2:3 lint/suspicious/noMisleadingInstantiator ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Don’t use the new method in classes.
  
    1 │ class C {
  > 2 │   new(): C;
      │   ^^^^^^^^^
    3 │ }
    4 │ 
  
  ℹ new is typically used to instantiate objects. In classes, its usage can be misleading.

Valid

1
declare class C {
2
  constructor();
3
}
4

5
interface I {
6
  new (): C;
7
}