JS.TS.PREFER.FUNCTION.TYPE

Use function types instead of interfaces with call signatures

Rule Details

This rule suggests using a function type instead of an interface or object type literal with a single call signature.

Examples of code for this rule:

Incorrect

Copy

interface Foo {
  (): string;
}

Copy

function foo(bar: { (): number }): number {
  return bar();
}

Copy

interface Foo extends Function {
  (): void;
}

Copy

interface MixinMethod {
  // returns the function itself, not the `this` argument.
  (arg: string): this;
}

Correct

Copy

interface Foo {
  (): void;
  bar: number;
}

Copy

function foo(bar: { (): string; baz: number }): string {
  return bar();
}

Copy

interface Foo {
  bar: string;
}
interface Bar extends Foo {
  (): void;
}

Copy

// returns the `this` argument of function, retaining it's type.
type MixinMethod = <TSelf>(this: TSelf, arg: string) => TSelf;
// a function that returns itself is much clearer in this form.
type ReturnsSelf = (arg: string) => ReturnsSelf;

Copy

// multiple call signatures (overloads) is allowed:
interface Overloaded {
  (data: string): number;
  (id: number): string;
}
// this is equivelent to Overloaded interface.
type Intersection = ((data: string) => number) & ((id: number) => string);

Options

Copy

// .eslintrc.json
{
  "rules": {
    "@typescript-eslint/prefer-function-type": "warn"
  }
}

This rule is not configurable.

When Not To Use It

If you specifically want to use an interface or type literal with a single call signature for stylistic reasons, you can disable this rule.