no-promise-executor-return
禁止從 Promise executor 函數傳回值
💡 hasSuggestions
此規則報告的某些問題可以透過編輯器建議手動修正
new Promise 建構子接受單一參數，稱為 executor。
const myPromise = new Promise(function executor(resolve, reject) {
readFile('foo.txt', function(err, result) {
if (err) {
reject(err);
} else {
resolve(result);
}
});
});
executor 函數通常會啟動一些非同步操作。一旦完成，executor 應該使用結果呼叫 resolve，或者在發生錯誤時呼叫 reject。
executor 的傳回值會被忽略。從 executor 函數傳回值可能是一個錯誤，因為傳回的值無法使用，並且不會以任何方式影響 promise。
規則詳細資訊
此規則禁止從 Promise executor 函數傳回值。
僅允許沒有值的 return，因為它是一個控制流程語句。
此規則的錯誤程式碼範例
在 Playground 中開啟
/*eslint no-promise-executor-return: "error"*/
new Promise((resolve, reject) => {
if (someCondition) {
}
getSomething((err, result) => {
if (err) {
reject(err);
} else {
resolve(result);
}
});
});
new Promise((resolve, reject) => );
new Promise(() => {
});
new Promise(r => );
此規則的正確程式碼範例
在 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);
選項
此規則接受一個選項，一個物件，具有以下屬性
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));
相關規則
版本
此規則在 ESLint v7.3.0 中引入。
延伸閱讀