From 8308f88c00d0faf4ac11a3c2e0cc18a2481bead2 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Sat, 11 Mar 2023 18:49:07 -0500 Subject: [PATCH] docs(eslint-plugin): [prefer-function-type] mention global augmentation edge case in docs --- packages/eslint-plugin/docs/rules/prefer-function-type.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/eslint-plugin/docs/rules/prefer-function-type.md b/packages/eslint-plugin/docs/rules/prefer-function-type.md index 5ec8490a4879..a8aca65f296b 100644 --- a/packages/eslint-plugin/docs/rules/prefer-function-type.md +++ b/packages/eslint-plugin/docs/rules/prefer-function-type.md @@ -85,3 +85,8 @@ type Intersection = ((data: string) => number) & ((id: number) => string); ## 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. + +This rule has a known edge case of sometimes triggering on global augmentations such as `interface Function`. +These edge cases are rare and often symptomatic of odd code. +We recommend you use an [inline ESLint disable comment](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1). +See [#454](https://github.com/typescript-eslint/typescript-eslint/issues/454) for details. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy