Skip to content

Commit 6a4bbcf

Browse files
ijz953brandonroberts
authored andcommitted
feat(effects): export EffectConfig and add docs
1 parent b028ae5 commit 6a4bbcf

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

modules/effects/src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export { createEffect } from './effect_creator';
2+
export { EffectConfig } from './models';
23
export { Effect } from './effect_decorator';
34
export { getEffectsMetadata } from './effects_metadata';
45
export { mergeEffects } from './effects_resolver';

modules/effects/src/models.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1+
/**
2+
* Configures an effect creator. See `createEffect`.
3+
*/
14
export interface EffectConfig {
5+
/**
6+
* Determines if the action emitted by the effect is dispatched to the store.
7+
* If false, effect does not need to return type `Observable<Action>`.
8+
*/
29
dispatch?: boolean;
10+
/**
11+
* Determines if the effect will be resubscribed if an error occurs in the main actions stream.
12+
*/
313
resubscribeOnError?: boolean;
414
}
515

0 commit comments

Comments
 (0)