100 lines
2.6 KiB
Plaintext
100 lines
2.6 KiB
Plaintext
|
---
|
||
|
|
description: 'Require that function overload signatures be consecutive.'
|
||
|
|
---
|
||
|
|
|
||
|
|
> 🛑 This file is source code, not the primary documentation location! 🛑
|
||
|
|
>
|
||
|
|
> See **https://typescript-eslint.io/rules/adjacent-overload-signatures** for documentation.
|
||
|
|
|
||
|
|
Function overload signatures represent multiple ways a function can be called, potentially with different return types.
|
||
|
|
It's typical for an interface or type alias describing a function to place all overload signatures next to each other.
|
||
|
|
If Signatures placed elsewhere in the type are easier to be missed by future developers reading the code.
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!--tabs-->
|
||
|
|
|
||
|
|
### ❌ Incorrect
|
||
|
|
|
||
|
|
```ts
|
||
|
|
declare namespace Foo {
|
||
|
|
export function foo(s: string): void;
|
||
|
|
export function foo(n: number): void;
|
||
|
|
export function bar(): void;
|
||
|
|
export function foo(sn: string | number): void;
|
||
|
|
}
|
||
|
|
|
||
|
|
type Foo = {
|
||
|
|
foo(s: string): void;
|
||
|
|
foo(n: number): void;
|
||
|
|
bar(): void;
|
||
|
|
foo(sn: string | number): void;
|
||
|
|
};
|
||
|
|
|
||
|
|
interface Foo {
|
||
|
|
foo(s: string): void;
|
||
|
|
foo(n: number): void;
|
||
|
|
bar(): void;
|
||
|
|
foo(sn: string | number): void;
|
||
|
|
}
|
||
|
|
|
||
|
|
class Foo {
|
||
|
|
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;
|
||
|
|
```
|
||
|
|
|
||
|
|
### ✅ Correct
|
||
|
|
|
||
|
|
```ts
|
||
|
|
declare namespace Foo {
|
||
|
|
export function foo(s: string): void;
|
||
|
|
export function foo(n: number): void;
|
||
|
|
export function foo(sn: string | number): void;
|
||
|
|
export function bar(): void;
|
||
|
|
}
|
||
|
|
|
||
|
|
type Foo = {
|
||
|
|
foo(s: string): void;
|
||
|
|
foo(n: number): void;
|
||
|
|
foo(sn: string | number): void;
|
||
|
|
bar(): void;
|
||
|
|
};
|
||
|
|
|
||
|
|
interface Foo {
|
||
|
|
foo(s: string): void;
|
||
|
|
foo(n: number): void;
|
||
|
|
foo(sn: string | number): void;
|
||
|
|
bar(): void;
|
||
|
|
}
|
||
|
|
|
||
|
|
class Foo {
|
||
|
|
foo(s: string): void;
|
||
|
|
foo(n: number): void;
|
||
|
|
foo(sn: string | number): void {}
|
||
|
|
bar(): void {}
|
||
|
|
}
|
||
|
|
|
||
|
|
export function bar(): void;
|
||
|
|
export function foo(s: string): void;
|
||
|
|
export function foo(n: number): void;
|
||
|
|
export function foo(sn: string | number): void;
|
||
|
|
```
|
||
|
|
|
||
|
|
## When Not To Use It
|
||
|
|
|
||
|
|
It can sometimes be useful to place overload signatures alongside other meaningful parts of a type.
|
||
|
|
For example, if each of a function's overloads corresponds to a different property, you might wish to put each overloads next to its corresponding property.
|
||
|
|
You might consider using [ESLint disable comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1) for those specific situations instead of completely disabling this rule.
|
||
|
|
|
||
|
|
## Related To
|
||
|
|
|
||
|
|
- [`unified-signatures`](./unified-signatures.md)
|