promise.prototype.finally

ES Proposal spec-compliant shim for Promise.prototype.finally

Showing:

Popularity

Downloads/wk

3.2M

GitHub Stars

131

Maintenance

Last Commit

2mos ago

Contributors

1

Package

Dependencies

3

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

promise.prototype.finally Version Badge

github actions coverage dependency status dev dependency status License Downloads

npm badge

ES Proposal spec-compliant shim for Promise.prototype.finally. Invoke its "shim" method to shim Promise.prototype.finally if it is unavailable or noncompliant. Note: a global Promise must already exist: the es6-shim is recommended.

This package implements the es-shim API interface. It works in an ES3-supported environment that has Promise available globally, and complies with the proposed spec.

Most common usage:

var assert = require('assert');
var promiseFinally = require('promise.prototype.finally');

var resolved = Promise.resolve(42);
var rejected = Promise.reject(-1);

promiseFinally(resolved, function () {
    assert.equal(arguments.length, 0);

    return Promise.resolve(true);
}).then(function (x) {
    assert.equal(x, 42);
});

promiseFinally(rejected, function () {
    assert.equal(arguments.length, 0);
}).catch(function (e) {
    assert.equal(e, -1);
});

promiseFinally(rejected, function () {
    assert.equal(arguments.length, 0);

    throw false;
}).catch(function (e) {
    assert.equal(e, false);
});

promiseFinally.shim(); // will be a no-op if not needed

resolved.finally(function () {
    assert.equal(arguments.length, 0);

    return Promise.resolve(true);
}).then(function (x) {
    assert.equal(x, 42);
});

rejected.finally(function () {
    assert.equal(arguments.length, 0);
}).catch(function (e) {
    assert.equal(e, -1);
});

rejected.finally(function () {
    assert.equal(arguments.length, 0);

    throw false;
}).catch(function (e) {
    assert.equal(e, false);
});

Tests

Simply clone the repo, npm install, and run npm test

Thanks

Huge thanks go out to @matthew-andrews, who provided the npm package name for v2 of this module. v1 is both in the original repo and preserved in a branch

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial