useGetterReturn (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v1.0.0
Diagnostic Category: lint/suspicious/useGetterReturn
This rule is recommended, meaning it is enabled by default.
This rule doesn’t have a fix.
The default severity of this rule is error.
Sources:
- Same as getter-return

How to configure

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

Description

Enforce get methods to always return a value.

Examples

Invalid

1
class Person {
2
    get firstName() {}
3
}

code-block.js:2:5 lint/suspicious/useGetterReturn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This getter should return a value.
  
    1 │ class Person {
  > 2 │     get firstName() {}
      │     ^^^^^^^^^^^^^^^^^^
    3 │ }
    4 │ 
  
  ℹ A getter without a return statement always evaluates to undefined, so reading the property does not give the value the code intends.
  
  ℹ Add a return statement that returns the value of the property.

1
const obj = {
2
    get firstName() {
3
        return;
4
    }
5
}

code-block.js:3:9 lint/suspicious/useGetterReturn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This return should return a value because it is located in a getter.
  
    1 │ const obj = {
    2 │     get firstName() {
  > 3 │         return;
      │         ^^^^^^^
    4 │     }
    5 │ }
  
  ℹ A return without a value makes the getter evaluate to undefined, so reading the property does not give the value the code intends.
  
  ℹ Return the value of the property from this statement.

1
class Option {
2
    get value() {
3
        if (this.hasValue) {
4
            log();
5
        } else {
6
            return null;
7
        }
8
    }
9
}

code-block.js:2:5 lint/suspicious/useGetterReturn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This getter should return a value.
  
     1 │ class Option {
   > 2 │     get value() {
       │     ^^^^^^^^^^^^^
   > 3 │         if (this.hasValue) {
   > 4 │             log();
   > 5 │         } else {
   > 6 │             return null;
   > 7 │         }
   > 8 │     }
       │     ^
     9 │ }
    10 │ 
  
  ℹ A getter without a return statement always evaluates to undefined, so reading the property does not give the value the code intends.
  
  ℹ Add a return statement that returns the value of the property.

Valid

1
class Person {
2
    get firstName() {
3
        return this.fullname.split(" ")[0];
4
    }
5
}

1
const obj = {
2
    get firstName() {
3
        return this.fullname.split(" ")[0];
4
    }
5
}

useGetterReturn (JavaScript)

Summary

How to configure

Description

Examples

Invalid

Valid

Related links