bluebird
Konvertera ett återuppringnings-API till löften.
Sök…
Anmärkningar
Löften har tillstånd, de börjar vara i väntande och kan nöja sig med:
- uppfyllt vilket innebär att beräkningen slutfördes framgångsrikt.
- avvisade vilket innebär att beräkningen misslyckades.
Löften att återvända funktioner ska aldrig kasta , de ska returnera avslag istället. Genom att kasta från en löfte-återvändande funktion tvingas du att använda både en } catch { och en .catch . Personer som använder utlovade API: er förväntar sig inte löften att kasta. Om du inte är säker på hur async API: er fungerar i JS - se detta svar först.
Konvertera en hel NodeJS-modul på en gång
Låt oss säga att du har ett bibliotek som returnerar återuppringningar, till exempel fs modulen i NodeJS:
const fs = require("fs");
fs.readFile("/foo.txt", (err, data) => {
if(err) throw err;
console.log(data);
});
Vi vill konvertera det till ett löfte som återlämnar API, med bluebird - vi kan göra detta med promisifyAll som konverterar ett helt API för att använda löften:
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);
Som låter dig använda hela modulen som löften.
Här är några vanliga exempel på hur man lovar vissa moduler:
// 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"));
Konvertera en enda NodeJS-funktion
Du kan konvertera en enda funktion med ett återuppringningsargument till en Promise returning-version med Promise.promisify , så detta:
const fs = require("fs");
fs.readFile("foo.txt", (err, data) => {
if(err) throw err;
console.log(data);
});
blir:
const promisify = require("bluebird");
const readFile = promisify(require("fs").readFile));
readFile("foo.txt").then(console.log); // promisified version
Konvertera alla andra återuppringnings-API
För att konvertera alla återuppringnings-API till löften under förutsättning att promisify och promisifyAll versionen inte passar - kan du använda löftskonstruktören .
Att skapa löften innebär i allmänhet att ange när de löser sig - det betyder när de går till den uppfyllda (avslutade) eller avvisade (felaktiga) fasen för att indikera att uppgifterna är tillgängliga (och kan nås med. .then ).
new Promise((fulfill, reject) => { // call fulfill/reject to mark the promise
someCallbackFunction((data) => {
fulfill(data); // we mark it as completed with the value
})
});
Låt oss som exempel konvertera setTimeout till löften:
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));
Vi kan nu använda det som en vanlig löfte-återvändande funktion:
delay(1000).then(() => console.log("One second passed")).
then(() => delay(1000)).
then(() => console.log("Another second passed"));