Expose wrapper promise as a prop so it can be chained on (fixes #79)

[ghengeveld]

Description

This exposes a new promise prop, which is the internal wrapper Promise created when starting the promiseFn. This wrapper promise fulfills and rejects along with the underlying promise, so it behaves as one would expect, contrary to the promise returned by run, which always fulfilled. Because the promise returned by run is an oddball and not frequently used (it was even untested), it was changed to just return undefined.

This fixes #79

Breaking changes

The return type for run was changed from Promise to undefined. You should now use the promise prop instead. This change cannot be automated, so you should upgrade manually.

Checklist

Make sure you check all the boxes. You can omit items that are not applicable.

• Implementation for both <Async> and useAsync()
• Added / updated the unit tests
• Added / updated the documentation
• Updated the PropTypes
• Updated the TypeScript type definitions

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.31%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      735      +24     
  Branches      157      161       +4     
==========================================
+ Hits          706      730      +24     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.02%)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...a453148. Read the comment docs.

[codecov]

Codecov Report

Merging #83 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   99.29%   99.32%   +0.02%     
==========================================
  Files           9        9              
  Lines         711      736      +25     
  Branches      157      160       +3     
==========================================
+ Hits          706      731      +25     
  Misses          5        5

Impacted Files	Coverage Δ
packages/react-async/src/reducer.js	100% <ø> (ø)	⬆️
packages/react-async/src/propTypes.js	100% <ø> (ø)	⬆️
packages/react-async/src/Async.js	100% <100%> (ø)	⬆️
packages/react-async/src/specs.js	99.72% <100%> (+0.01%)	⬆️
packages/react-async/src/useAsync.js	99% <100%> (+0.03%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b59ec7...50f341e. Read the comment docs.

[ghengeveld]

Released in v8.0.0

[ghengeveld]

Thanks, I answered your question on SO. Basically this is a bug which will be fixed soon. See also #92 (comment)