no-promise-executor-return

禁止从 Promise 执行器函数返回值

💡

此规则报告的一些问题可以通过编辑器建议手动修复

new Promise 构造函数接受一个参数，称为执行器。

const myPromise = new Promise(function executor(resolve, reject) {
    readFile('foo.txt', function(err, result) {
        if (err) {
            reject(err);
        } else {
            resolve(result);
        }
    });
});
1
2
3
4
5
6
7
8
9

执行器函数通常启动一些异步操作。一旦完成，执行器应该使用结果调用 resolve，或者在发生错误时调用 reject。

执行器的返回值被忽略。从执行器函数返回值可能是一个错误，因为返回的值不能被使用，并且它不会以任何方式影响 promise。

规则详情

此规则禁止从 Promise 执行器函数返回值。

只允许没有值的 return，因为它是一个控制流语句。

此规则的错误代码示例

在 Playground 中打开

/*eslint no-promise-executor-return: "error"*/

new Promise((resolve, reject) => {
    if (someCondition) {
        return defaultResult;
    }
    getSomething((err, result) => {
        if (err) {
            reject(err);
        } else {
            resolve(result);
        }
    });
});

new Promise((resolve, reject) => getSomething((err, data) => {
    if (err) {
        reject(err);
    } else {
        resolve(data);
    }
}));

new Promise(() => {
    return 1;
});

new Promise(r => r(1));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

此规则的正确代码示例

在 Playground 中打开

/*eslint no-promise-executor-return: "error"*/

// Turn return inline into two lines
new Promise((resolve, reject) => {
    if (someCondition) {
        resolve(defaultResult);
        return;
    }
    getSomething((err, result) => {
        if (err) {
            reject(err);
        } else {
            resolve(result);
        }
    });
});

// Add curly braces
new Promise((resolve, reject) => {
    getSomething((err, data) => {
        if (err) {
            reject(err);
        } else {
            resolve(data);
        }
    });
});

new Promise(r => { r(1) });
// or just use Promise.resolve
Promise.resolve(1);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

选项

此规则接受一个选项，一个对象，具有以下属性

allowVoid：如果设置为 true（默认为 false），此规则将允许返回 void 值。

allowVoid

使用 { "allowVoid": true } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint no-promise-executor-return: ["error", { allowVoid: true }]*/

new Promise((resolve, reject) => {
    if (someCondition) {
        return void resolve(defaultResult);
    }
    getSomething((err, result) => {
        if (err) {
            reject(err);
        } else {
            resolve(result);
        }
    });
});

new Promise((resolve, reject) => void getSomething((err, data) => {
    if (err) {
        reject(err);
    } else {
        resolve(data);
    }
}));

new Promise(r => void r(1));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

版本

此规则在 ESLint v7.3.0 中引入。

延伸阅读

Promise - JavaScript | MDN
developer.mozilla.org

资源

编辑此页

no-promise-executor-return

规则详情

选项

allowVoid

相关规则

版本

延伸阅读

资源