Giter VIP home page Giter VIP logo

node-api-promises's Introduction

General Assembly Logo

Using Promises with the Node API

Prerequisites

Objectives

By the end of this, developers should be able to:

  • Explain the value of using promises instead of callback interfaces.
  • Read Node documentation that uses callbacks and translate that into implementations using promises.
  • Rewrite Node scripts using callbacks as scripts using promises.

Preparation

  1. Fork and clone this repository.
  2. Install dependencies with npm install.

Drawbacks to Callbacks

Asynchronous code necessitates callbacks. But dealing with lots of callbacks can be tricky:

  • Callbacks can be messy when they're nested: "callback hell". See lib/copy-json.js.
  • Each callback will have to handle it's own errors if necessary.
  • In complex programs, it will be hard to tell in what order callbacks fire.

Fortunately, there's a better way: Promises.

Lab: Research the Promises API

Promises are objects that represent steps in an asynchronous process. As of 2016, they are natively supported in Node.

Take a few minutes to read the API documentation on Promises. Note function signatures and argument types as you read. What arguments does a promise take when it is constructed?

  1. Promise Syntax
  2. Promise.prototype

Annotate-Along: Using Promises Instead of Callbacks

Promises offer several advantages over callbacks.

  • Promises, like callbacks, make asynchronicity explicit.
  • Promises, unlike callbacks, clarify the order of execution.
  • Promises are easier to read than callbacks.
  • Promises can simplify error handling.
// remember that callback is something you write, in this case to perform some
// processing on parsed JSON
const readJSON = function (filename, callback){
  fs.readFile(filename, 'utf8', function (err, res){
    if (err) {
      return callback(err); // what's going on here?
    }
    callback(null, JSON.parse(res)); // what if JSON.parse errors out?
  });
};

What are some weaknesses in this code? And the following?

const readJSON = function (filename, callback){ // 👀 here
  fs.readFile(filename, 'utf8', function (err, res){
    if (err) {
      return callback(err); // pass the error from readFile
    }
    try {
      res = JSON.parse(res);
    } catch (ex) {
      return callback(ex); // pass the error from JSON.parse
    }
    callback(null, res); // don't pass the error, since we should have caught it
  });
};

What about this instead?

const readJSON = function (filename) { // <-- look here
  return new Promise((resolve, reject) => {
    fs.readFile(filename, { encoding: 'utf8' }, (err, res) => {
      if (err) {
        reject(err);
      } else {
        resolve(res);
      }
    });
  })
  .then((res) => {
    return JSON.parse(res)
  });
};

readJSON('./example.json')
  .then((pojo) => {
    callback(pojo); // do something with the object
  })
  .catch((err) => { // handle error conditions
    console.error(err);
  });

That's too verbose. This is better:

const readJSON = function (filename) {
  return new Promise((resolve, reject) => {
    fs.readFile(filename, { encoding: 'utf8' }, (err, res) => {
      if (err) {
        reject(err);
      } else {
        resolve(res);
      }
    });
  })
  .then(JSON.parse); // what can we surmise about .then?
};


readJSON('./example.json')
  .then(callback) // do something with the object
  .catch(console.error);  // handle error conditions

Code-Along: Promisify copy-json.js

Lab: Promisify hey-yall.js

Lab: Promisify randomizer.js

Additional Resources

  1. All content is licensed under a CC­BY­NC­SA 4.0 license.
  2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact [email protected].

node-api-promises's People

Contributors

ga-meb avatar payne-chris-r avatar raq929 avatar

Watchers

James Cloos avatar Dale Dobson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.