noConstructorReturn

JavaScript (and super languages)

Summary

Rule available since: v1.0.0
Diagnostic Category: lint/correctness/noConstructorReturn
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 no-constructor-return

Description

Disallow returning a value from a constructor.

Returning a value from a constructor of a class is a possible error. Forbidding this pattern prevents errors resulting from unfamiliarity with JavaScript or a copy-paste error.

Only returning without a value is allowed, as it’s a control flow statement.

Examples

Invalid

1
class A {
2
    constructor() {
3
        return 0;
4
    }
5
}

code-block.js:3:9 lint/correctness/noConstructorReturn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ The constructor should not return a value.
  
    1 │ class A {
    2 │     constructor() {
  > 3 │         return 0;
      │         ^^^^^^^^^
    4 │     }
    5 │ }
  
  ℹ The constructor is here:
  
    1 │ class A {
  > 2 │     constructor() {
      │     ^^^^^^^^^^^^^^^
  > 3 │         return 0;
  > 4 │     }
      │     ^
    5 │ }
    6 │ 
  
  ℹ Returning a value from a constructor may confuse users of the class.

Valid

1
class A {
2
    constructor() {}
3
}

1
class B {
2
    constructor(x) {
3
        return;
4
    }
5
}

Using this rule in combination with the singleton pattern

Some people implement the singleton pattern in JavaScript by returning an existing instance from the constructor, which would conflict with this rule.

Instead, we advise to follow one of the suggestions described in this blog post: https://arendjr.nl/blog/2024/11/singletons-in-javascript/

How to configure

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