Skip to content

Commit

Permalink
Update effects.d.ts code docs to reflect puts error bubbling behavior (
Browse files Browse the repository at this point in the history
…#2360)

The documentation here doesn't match what the real behavior is. (Also inconsistent with the readme docs)
  • Loading branch information
shaunwhyte authored Feb 6, 2023
1 parent 38ac71b commit fa8bc3b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions packages/core/types/effects.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -359,8 +359,8 @@ export type HelperWorkerParameters<T, Fn extends (...args: any[]) => any> = Last

/**
* Creates an Effect description that instructs the middleware to dispatch an
* action to the Store. This effect is non-blocking and any errors that are
* thrown downstream (e.g. in a reducer) will not bubble back into the saga.
* action to the Store. This effect is non-blocking, any errors that are
* thrown downstream (e.g. in a reducer) will bubble back into the saga.
*
* @param action [see Redux `dispatch` documentation for complete info](https://redux.js.org/api/store#dispatchaction)
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/core/types/ts3.6/effects.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -378,8 +378,8 @@ export type HelperWorkerParameters<T, Fn extends (...args: any[]) => any> = Last

/**
* Creates an Effect description that instructs the middleware to dispatch an
* action to the Store. This effect is non-blocking and any errors that are
* thrown downstream (e.g. in a reducer) will not bubble back into the saga.
* action to the Store. This effect is non-blocking, any errors that are
* thrown downstream (e.g. in a reducer) will bubble back into the saga.
*
* @param action [see Redux `dispatch` documentation for complete info](https://redux.js.org/api/store#dispatchaction)
*/
Expand Down

0 comments on commit fa8bc3b

Please sign in to comment.