goify v0.0.1

goify

goify transforms JavaScript Promises into go-like Promises.

Table of Contents

• Introduction
• Installing
• Usage
• Contributing and help
  • Criticism
  • Developing
  • Bug reports, feature requests and discussion
• License
• Frequently Asked Questions

Introduction

TODO.

Installing

npm install --save goify

Usage

Here you have a illustrative example on how to use it:

const goify = require('goify').all;


goify(Promise.resolve('foobar'));
//> [ 'foobar', null ]

goify(Promise.reject('foobar'));
//> [ undefined, 'foobar' ]


function someJob() {
    // Returns a promise which resolves a value or rejects an error
}
const [ result, someJobErr ] = await someJob();
if (someJobError) {
    console.error('someJob failed for job #x. Details:', someJobError);
    return;
}

Both source code and tests are minimal and can give you a good idea about how to use goify.

Contributing and help

Criticism

If you think something could be done better or simply sucks, bring up a issue on the tracker. Don't be shy. I really love feedback and technical discussions.

Developing

Pull requests are welcome (and will make me cry in joy). Also, did I already say that I love technical discussions? Feel free to open a issue on the tracker if you have any doubt.

Bug reports, feature requests and discussion

Use the GitHub issue tracker to report any bugs or file feature requests. In case you found a bug and have no GitHub account, feel free to email me: fcanela.dev at gmail dot com.

License

Copyright (c) 2017 Francisco Canela. Licensed under the MIT license.

Frequently Asked Questions

Should I use it in my project?

Probably not. At least, not yet. I usually follow semver for modules versioning and while it is at 0.x.x you can expect breaking changes.

This project documentation sucks

Yes, I know. Unfortunately I have limited time resources. Feel free to open a issue or sumbit a pull request if you can help me improving this.