getterReturns

Reports getter functions that do not return values.

✅ This rule is included in the ts untyped presets.

The get syntax binds an object property to a function that will be called when that property is looked up. A getter is expected to return a value; otherwise, accessing the property will return undefined, which is likely unintentional.

This rule reports when a getter does not explicitly return a value.

const 
const object: {
    readonly value: void;
}
object = {
  get value() {Error ts(2378)  ― A 'get' accessor must return a value.
    
var console: Console
The console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
The module exports two specific components:

A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
A global console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.

Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
Example using the global console:
console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
//   Error: Whoops, something bad happened
//     at [eval]:5:15
//     at Script.runInThisContext (node:vm:132:18)
//     at Object.runInThisContext (node:vm:309:38)
//     at node:internal/process/execution:77:19
//     at [eval]-wrapper:6:22
//     at evalScript (node:internal/process/execution:76:60)
//     at node:internal/main/eval_string:23:3

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
Example using the Console class:
const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err
@see ― source
console.
Console.log(message?: any, ...optionalParams: any[]): void (+1 overload)
Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout
See util.format() for more information.
@since ― v0.1.100
log("accessed");
  },
};

class 
class Example
Example {
  get value() {Error ts(2378)  ― A 'get' accessor must return a value.
    this.compute();Error ts(2339)  ― Property 'compute' does not exist on type 'Example'.
  }
}

class 
class Example
Example {
  get 
Example.value: void
value() {
    return;
  }
}

const 
const object: {
    readonly value: any;
}
object = {
  get 
value: any
value() {
    return this._value;Error ts(2551)  ― Property '_value' does not exist on type '{ readonly value: any; }'. Did you mean 'value'?
  },
};

class 
class Example
Example {
  get 
Example.value: any
value() {
    return this._value;Error ts(2551)  ― Property '_value' does not exist on type 'Example'. Did you mean 'value'?
  }
}

class 
class Example
Example {
  get 
Example.value: any
value() {
    if (this.condition) {Error ts(2339)  ― Property 'condition' does not exist on type 'Example'.
      return this.data;Error ts(2339)  ― Property 'data' does not exist on type 'Example'.
    }
    return this.defaultValue;Error ts(2339)  ― Property 'defaultValue' does not exist on type 'Example'.
  }
}

Options

This rule is not configurable.

When Not To Use It

TypeScript’s compiler already enforces that getters with an explicit return type must return a value. If all getters in your codebase use explicit return types, you might not need this rule. However, this rule also catches implicit undefined returns in getters that lack return type annotations.

Equivalents in Other Linters

Made with ❤️‍🔥 around the world by the Flint team and contributors.

getterReturns

Examples

Options

When Not To Use It

Further Reading

Equivalents in Other Linters