bluebird
Conversione di un'API di callback in promesse.
Ricerca…
Osservazioni
Le promesse hanno lo stato, iniziano come in sospeso e possono accontentarsi di:
- significato compiuto che il calcolo è stato completato con successo.
- significato rifiutato che il calcolo non è riuscito.
Promettere che le funzioni di ritorno non dovrebbero mai essere lanciate , dovrebbero invece restituire i rifiuti. Lanciare da una funzione di ritorno promessa ti costringerà ad usare sia un } catch { che un .catch . Le persone che utilizzano le API promesse non si aspettano che le promesse vengano lanciate. Se non sei sicuro di come funzionano le API asincrone in JS, consulta prima questa risposta .
Convertire un intero modulo NodeJS in una sola volta
Supponiamo che tu abbia una libreria che restituisce i callback, ad esempio il modulo fs in NodeJS:
const fs = require("fs");
fs.readFile("/foo.txt", (err, data) => {
if(err) throw err;
console.log(data);
});
Vogliamo convertirlo in API di ritorno promettenti, con bluebird: possiamo farlo utilizzando promisifyAll che converte un'intera API per utilizzare le promesse:
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);
Che ti consente di utilizzare l'intero modulo come promesse.
Ecco alcuni ecxample comuni su come promuovere determinati moduli:
// 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"));
Conversione di una singola funzione NodeJS
È possibile convertire una singola funzione con un argomento di callback in una versione Promise -returning con Promise.promisify , quindi questo:
const fs = require("fs");
fs.readFile("foo.txt", (err, data) => {
if(err) throw err;
console.log(data);
});
diventa:
const promisify = require("bluebird");
const readFile = promisify(require("fs").readFile));
readFile("foo.txt").then(console.log); // promisified version
Conversione di qualsiasi altra API di callback
Per convertire qualsiasi API di callback in promesse presupponendo che la versione promisify e promisifyAll non si adatti, è possibile utilizzare il costruttore di promesse .
Generare promesse significa in genere specificare quando si stabiliscono - ciò significa che quando si passa alla fase completata (completata) o rifiutata (errata) per indicare che i dati sono disponibili (e che è possibile accedere con .then ).
new Promise((fulfill, reject) => { // call fulfill/reject to mark the promise
someCallbackFunction((data) => {
fulfill(data); // we mark it as completed with the value
})
});
Ad esempio, convertiamo setTimeout per usare le promesse:
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));
Ora possiamo usarlo come una normale funzione di ritorno promessa:
delay(1000).then(() => console.log("One second passed")).
then(() => delay(1000)).
then(() => console.log("Another second passed"));