typescript/prefer-promise-reject-errors Pedantic
作用
此规则强制将 Error 对象传递给 Promise.reject()。
为什么这是不好的？
通常认为，只用 Error 对象来拒绝 Promise 是一种良好实践。这是因为 Error 对象会自动捕获堆栈跟踪，这对调试很有帮助。此外，一些工具和环境期望拒绝原因是 Error 对象。
示例
此规则的错误代码示例：
ts
Promise.reject("error"); // 使用字符串拒绝
Promise.reject(42); // 使用数字拒绝
Promise.reject(true); // 使用布尔值拒绝
Promise.reject({ message: "error" }); // 使用普通对象拒绝
Promise.reject(null); // 使用 null 拒绝
Promise.reject(); // 使用 undefined 拒绝
const error = "出现了问题";
Promise.reject(error); // 使用非 Error 变量拒绝此规则的正确代码示例：
ts
Promise.reject(new Error("出现了问题"));
Promise.reject(new TypeError("无效类型"));
Promise.reject(new RangeError("值超出范围"));
// 自定义 Error 子类
class CustomError extends Error {
constructor(message: string) {
super(message);
this.name = "CustomError";
}
}
Promise.reject(new CustomError("发生了自定义错误"));
// 值为 Error 对象的变量
const error = new Error("错误消息");
Promise.reject(error);配置
此规则接受一个包含以下属性的配置对象：
allow
type: array
default: []
允许作为 Promise 拒绝原因的附加类型或值说明符数组。
allow[n]
type: object | string
用于匹配特定声明的类型或值说明符
支持四种说明符类型：
- 字符串说明符（已弃用）：按名称进行通用匹配
json
"Promise"- 文件说明符：匹配在本地文件中声明的类型/值
json
{ "from": "file", "name": "MyType" }
{ "from": "file", "name": ["Type1", "Type2"] }
{ "from": "file", "name": "MyType", "path": "./types.ts" }- 库说明符：匹配 TypeScript 内置 lib 类型
json
{ "from": "lib", "name": "Promise" }
{ "from": "lib", "name": ["Promise", "PromiseLike"] }- 包说明符：匹配来自 npm 包的类型/值
json
{ "from": "package", "name": "Observable", "package": "rxjs" }
{ "from": "package", "name": ["Observable", "Subject"], "package": "rxjs" }allow[n].from
type: "file"
必须为 "file"
allow[n].name
type: array | string
要匹配的类型或值的名称
名称说明符，可以是单个字符串或字符串数组
allow[n].name[n]
type: string
allow[n].path
type: string
可选的文件路径，用于指定类型或值必须在哪些位置声明。 如果省略，则会匹配所有文件。
allowEmptyReject
type: boolean
default: false
是否允许在不传入任何参数的情况下调用 Promise.reject()。
allowThrowingAny
type: boolean
default: false
是否允许拒绝类型为 any 的 Promise。
allowThrowingUnknown
type: boolean
default: false
是否允许拒绝类型为 unknown 的 Promise。
如何使用
To enable this rule using the config file or in the CLI, you can use:
json
{
"options": {
"typeAware": true
},
"rules": {
"typescript/prefer-promise-reject-errors": "error"
}
}ts
import { defineConfig } from "oxlint";
export default defineConfig({
options: { typeAware: true },
rules: {
"typescript/prefer-promise-reject-errors": "error",
},
});bash
oxlint --type-aware --deny typescript/prefer-promise-reject-errors版本
此规则在 v1.12.0 中添加。