1
0
Fork 0
mirror of https://github.com/actions/setup-node synced 2024-12-23 13:42:42 +00:00
setup-node/node_modules/p-finally/readme.md

48 lines
949 B
Markdown
Raw Permalink Normal View History

2019-08-06 22:29:44 +00:00
# p-finally [![Build Status](https://travis-ci.org/sindresorhus/p-finally.svg?branch=master)](https://travis-ci.org/sindresorhus/p-finally)
> [`Promise#finally()`](https://github.com/tc39/proposal-promise-finally) [ponyfill](https://ponyfill.com) - Invoked when the promise is settled regardless of outcome
Useful for cleanup.
## Install
```
$ npm install --save p-finally
```
## Usage
```js
const pFinally = require('p-finally');
const dir = createTempDir();
pFinally(write(dir), () => cleanup(dir));
```
## API
### pFinally(promise, [onFinally])
Returns a `Promise`.
#### onFinally
Type: `Function`
Note: Throwing or returning a rejected promise will reject `promise` with the rejection reason.
## Related
- [p-try](https://github.com/sindresorhus/p-try) - `Promise#try()` ponyfill - Starts a promise chain
- [More…](https://github.com/sindresorhus/promise-fun)
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)