Skip to main content

explicit-module-boundary-types

Require explicit return and argument types on exported functions' and classes' public class methods.


函数返回值和参数的显式类型使任何调用代码都清楚模块边界的输入和输出是什么。 为这些类型添加显式类型注释有助于提高代码可读性。 它还可以提高较大代码库上的 TypeScript 类型检查性能。

英：Explicit types for function return values and arguments makes it clear to any calling code what is the module boundary's input and output. Adding explicit type annotations for those types can help improve code readability. It can also improve TypeScript type checking performance on larger codebases.

.eslintrc.cjs
module.exports = {
  "rules": {
    "@typescript-eslint/explicit-module-boundary-types": "error"
  }
};
在线运行试试这个规则 ↗

示例​

// Should indicate that no value is returned (void)
export function test() {
  return;
}

// Should indicate that a string is returned
export var arrowFn = () => 'test';

// All arguments should be typed
export var arrowFn = (arg): string => `test ${arg}`;
export var arrowFn = (arg: any): string => `test ${arg}`;

export class Test {
  // Should indicate that no value is returned (void)
  method() {
    return;
  }
}
Open in Playground

选项​

在混合 JS/TS 代码库中进行配置​

如果你正在开发的代码库中包含 lint 非 TypeScript 代码（即 .js/.mjs/.cjs/.jsx），则应确保应使用 ESLint overrides 仅在 .ts/.mts/.cts/.tsx 文件上启用规则。 如果不这样做，那么你将在 .js/.mjs/.cjs/.jsx 文件中报告无法修复的 lint 错误。

英：If you are working on a codebase within which you lint non-TypeScript code (i.e. .js/.mjs/.cjs/.jsx), you should ensure that you should use ESLint overrides to only enable the rule on .ts/.mts/.cts/.tsx files. If you don't, then you will get unfixable lint errors reported within .js/.mjs/.cjs/.jsx files.

{
  "rules": {
    // disable the rule for all files
    "@typescript-eslint/explicit-module-boundary-types": "off"
  },
  "overrides": [
    {
      // enable the rule specifically for TypeScript files
      "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
      "rules": {
        "@typescript-eslint/explicit-module-boundary-types": "error"
      }
    }
  ]
}

allowArgumentsExplicitlyTypedAsAny​

此规则与 { allowArgumentsExplicitlyTypedAsAny: false } 的代码示例：

英：Examples of code for this rule with { allowArgumentsExplicitlyTypedAsAny: false }:

export const func = (value: any): number => value + 1;
Open in Playground

allowDirectConstAssertionInArrowFunctions​

此规则与 { allowDirectConstAssertionInArrowFunctions: false } 的代码示例：

英：Examples of code for this rule with { allowDirectConstAssertionInArrowFunctions: false }:

export const func = (value: number) => ({ type: 'X', value });
export const foo = () => ({
  bar: true,
});
export const bar = () => 1;
Open in Playground

allowedNames​

你可以传递你希望此规则忽略的函数/方法名称，如下所示：

英：You may pass function/method names you would like this rule to ignore, like so:

{
  "@typescript-eslint/explicit-module-boundary-types": [
    "error",
    {
      "allowedNames": ["ignoredFunctionName", "ignoredMethodName"]
    }
  ]
}

allowHigherOrderFunctions​

此规则与 { allowHigherOrderFunctions: false } 的代码示例：

英：Examples of code for this rule with { allowHigherOrderFunctions: false }:

export const arrowFn = () => () => {};

export function fn() {
  return function () {};
}

export function foo(outer: string) {
  return function (inner: string) {};
}
Open in Playground

allowTypedFunctionExpressions​

此规则与 { allowTypedFunctionExpressions: false } 的代码示例：

英：Examples of code for this rule with { allowTypedFunctionExpressions: false }:

export let arrowFn = () => 'test';

export let funcExpr = function () {
  return 'test';
};

export let objectProp = {
  foo: () => 1,
};

export const foo = bar => {};
Open in Playground

何时不使用它​

如果你的项目没有被对 API 类型敏感的下游消费者使用，你可以禁用此规则。

英：If your project is not used by downstream consumers that are sensitive to API types, you can disable this rule.

进一步阅读​

选项​

该规则接受以下选项

type Options = [
  {
    /** Whether to ignore arguments that are explicitly typed as `any`. */
    allowArgumentsExplicitlyTypedAsAny?: boolean;
    /**
     * Whether to ignore return type annotations on body-less arrow functions that return an `as const` type assertion.
     * You must still type the parameters of the function.
     */
    allowDirectConstAssertionInArrowFunctions?: boolean;
    /**
     * Whether to ignore return type annotations on functions immediately returning another function expression.
     * You must still type the parameters of the function.
     */
    allowHigherOrderFunctions?: boolean;
    /** Whether to ignore type annotations on the variable of a function expresion. */
    allowTypedFunctionExpressions?: boolean;
    /** An array of function/method names that will not have their arguments or return values checked. */
    allowedNames?: string[];
  },
];

const defaultOptions: Options = [
  {
    allowArgumentsExplicitlyTypedAsAny: false,
    allowDirectConstAssertionInArrowFunctions: true,
    allowedNames: [],
    allowHigherOrderFunctions: true,
    allowTypedFunctionExpressions: true,
  },
];

资源​