adjacent-overload-signatures

NOTE: this rule is part of the recommended rule set.

Enable full set in deno.json:

{
  "lint": {
    "rules": {
      "tags": ["recommended"]
    }
  }
}

Enable full set using the Deno CLI:

deno lint --rules-tags=recommended

This rule can be explictly included to or excluded from the rules present in the current tag by adding it to the include or exclude array in deno.json:

{
  "lint": {
    "rules": {
      "include": ["adjacent-overload-signatures"],
      "exclude": ["adjacent-overload-signatures"]
    }
  }
}

Requires overload signatures to be adjacent to each other.

Overloaded signatures which are not next to each other can lead to code which is hard to read and maintain.

Invalid:

(bar is declared in-between foo overloads)

type FooType = {
  foo(s: string): void;
  foo(n: number): void;
  bar(): void;
  foo(sn: string | number): void;
};

interface FooInterface {
  foo(s: string): void;
  foo(n: number): void;
  bar(): void;
  foo(sn: string | number): void;
}

class FooClass {
  foo(s: string): void;
  foo(n: number): void;
  bar(): void {}
  foo(sn: string | number): void {}
}

export function foo(s: string): void;
export function foo(n: number): void;
export function bar(): void {}
export function foo(sn: string | number): void {}

Valid:

(bar is declared after foo)

type FooType = {
  foo(s: string): void;
  foo(n: number): void;
  foo(sn: string | number): void;
  bar(): void;
};

interface FooInterface {
  foo(s: string): void;
  foo(n: number): void;
  foo(sn: string | number): void;
  bar(): void;
}

class FooClass {
  foo(s: string): void;
  foo(n: number): void;
  foo(sn: string | number): void {}
  bar(): void {}
}

export function foo(s: string): void;
export function foo(n: number): void;
export function foo(sn: string | number): void {}
export function bar(): void {}

adjacent-overload-signatures

Did you find what you needed?