Document a callback with multiple arguments about es6-promisify HOT 7 CLOSED

I think you got it the other way around. Promises always return a single value (could be an Array of values, of course. see Promise.all()). Callbacks indeed could take more than just (err, value).

from es6-promisify.

I think you got it the other way around.

Was my proposed example incorrect? It was just a sample, the docs could contain any example.

Promises always return a single value

I know but to me it was not totally obvious how es6-promisify would wrap a node-style function that executes a callback with multiple args. If you think it's obvious then feel free to close the bug. It should be easy to document how a callback with multiple args gets wrapped by es6-promisify though, it's only a couple more lines in your docs. You could copy/paste what I added here.

from es6-promisify.

I fully agree! 👍 I'd like that documentation and actually I don't even know what es6-promisify does in this case, do you?

I have misread the description of your second snippet: "For those unfamiliar with promises, THEY would expect it to look more like:". Sorry 😄

from es6-promisify.

I don't even know what es6-promisify does in this case, do you?

Yes. My first example is correct, I tried it. You have to use it like this:

import tmp from 'tmp';  // node builtin

let createTmpDir = promisify(tmp.dir);
createTmpDir()
  .then((result) => {
    let [tmpPath, removeTmpDir] = result;
    // ...
  });

from es6-promisify.

Pull requests cheerfully accepted :)

from es6-promisify.

Pull requests cheerfully accepted :)

Feel free to close the issue, it was just a suggestion. I don't have time for a patch right now. Maybe later.

from es6-promisify.

This issue can be closed now. I just saw the new multiArg feature and it seems well documented: https://github.com/digitaldesignlabs/es6-promisify#handle-callback-multiple-arguments

FWIW, I don't fully understand this change. Any reason why multiArg: true isn't the default behavior? I can't think of a situation where one would expect it to work like multiArg: false. It seems convenient as a shortcut but it is confusing if you need to reach multiple callback arguments. Anyway, I updated my use of promisify() with {multiArg: true} and it's working fine.

from es6-promisify.