bluebird
Konwertowanie interfejsu API wywołania zwrotnego na obietnice.
Szukaj…
Uwagi
Obietnice mają swój stan, zaczynają się jako oczekujące i mogą ustąpić:
- spełnione, co oznacza, że obliczenia zostały zakończone pomyślnie.
- odrzucono, co oznacza, że obliczenia nie powiodły się.
Funkcje obiecujące powracające nigdy nie powinny rzucać , zamiast tego powinny zwracać odrzucenia. Wyrzucenie z funkcji zwrotu obietnicy zmusi cię do użycia zarówno } catch { i .catch . Osoby korzystające z obiecanych interfejsów API nie oczekują, że obietnice zostaną rzucone. Jeśli nie masz pewności, jak działają asynchroniczne interfejsy API w JS - najpierw zapoznaj się z tą odpowiedzią .
Konwertowanie całego modułu NodeJS jednocześnie
Załóżmy, że masz bibliotekę, która zwraca wywołania zwrotne, na przykład moduł fs w NodeJS:
const fs = require("fs");
fs.readFile("/foo.txt", (err, data) => {
if(err) throw err;
console.log(data);
});
Chcemy przekonwertować go na API zwracające obietnice za pomocą promisifyAll - możemy to zrobić za pomocą promisifyAll który konwertuje cały API do korzystania z obietnic:
const Promise = require("bluebird");
const fs = Promise.promisifyAll(require("fs"));
// this automatically adds `Async` postfixed methods to `fs`.
fs.readFileAsync("/foo.txt").then(console.log);
Co pozwala wykorzystać cały moduł jako obietnicę.
Oto kilka typowych przykładów promowania niektórych modułów:
// The most popular redis module
var Promise = require("bluebird");
Promise.promisifyAll(require("redis"));
// The most popular mongodb module
var Promise = require("bluebird");
Promise.promisifyAll(require("mongodb"));
// The most popular mysql module
var Promise = require("bluebird");
// Note that the library's classes are not properties of the main export
// so we require and promisifyAll them manually
Promise.promisifyAll(require("mysql/lib/Connection").prototype);
Promise.promisifyAll(require("mysql/lib/Pool").prototype);
// Mongoose
var Promise = require("bluebird");
Promise.promisifyAll(require("mongoose"));
// Request
var Promise = require("bluebird");
Promise.promisifyAll(require("request"));
// Use request.getAsync(...) not request(..), it will not return a promise
// mkdir
var Promise = require("bluebird");
Promise.promisifyAll(require("mkdirp"));
// Use mkdirp.mkdirpAsync not mkdirp(..), it will not return a promise
// winston
var Promise = require("bluebird");
Promise.promisifyAll(require("winston"));
// rimraf
var Promise = require("bluebird");
// The module isn't promisified but the function returned is
var rimrafAsync = Promise.promisify(require("rimraf"));
// xml2js
var Promise = require("bluebird");
Promise.promisifyAll(require("xml2js"));
// jsdom
var Promise = require("bluebird");
Promise.promisifyAll(require("jsdom"));
// fs-extra
var Promise = require("bluebird");
Promise.promisifyAll(require("fs-extra"));
// prompt
var Promise = require("bluebird");
Promise.promisifyAll(require("prompt"));
// Nodemailer
var Promise = require("bluebird");
Promise.promisifyAll(require("nodemailer"));
// ncp
var Promise = require("bluebird");
Promise.promisifyAll(require("ncp"));
// pg
var Promise = require("bluebird");
Promise.promisifyAll(require("pg"));
Konwertowanie pojedynczej funkcji NodeJS
Możesz przekonwertować pojedynczą funkcję z argumentem wywołania zwrotnego na wersję zwracającą Promise za pomocą Promise.promisify , więc to:
const fs = require("fs");
fs.readFile("foo.txt", (err, data) => {
if(err) throw err;
console.log(data);
});
staje się:
const promisify = require("bluebird");
const readFile = promisify(require("fs").readFile));
readFile("foo.txt").then(console.log); // promisified version
Konwertowanie dowolnego innego interfejsu API wywołania zwrotnego
Aby przekonwertować dowolny interfejs API wywołania zwrotnego na obietnice przy założeniu, że wersja promisify i promisifyAll wersje nie pasują - możesz użyć konstruktora obietnic .
Tworzenie obietnic ogólnie oznacza określenie, kiedy się rozliczają - to znaczy, kiedy przechodzą do fazy spełnionej (ukończonej) lub odrzuconej (błędnej), aby wskazać, że dane są dostępne (i można uzyskać do nich dostęp za pomocą. .then ).
new Promise((fulfill, reject) => { // call fulfill/reject to mark the promise
someCallbackFunction((data) => {
fulfill(data); // we mark it as completed with the value
})
});
Jako przykład przekonwertujmy setTimeout aby użyć obietnic:
function delay(ms) { // our delay function that resolves after ms milliseconds
return new Promise((resolve, reject) => { // return a new promise
setTimeout(resolve, ms); // resolve it after `ms` milliseconds have passed
})
}
// or more concisely:
const delay = ms => new Promise(r => setTimeout(r, ms));
Możemy teraz używać go jak zwykłej funkcji zwrotu obietnicy:
delay(1000).then(() => console.log("One second passed")).
then(() => delay(1000)).
then(() => console.log("Another second passed"));