Skip to content

Commit

Permalink
feat(effects): export EffectConfig and add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ijz953 authored and brandonroberts committed Jul 7, 2019
1 parent b028ae5 commit 6a4bbcf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions modules/effects/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export { createEffect } from './effect_creator';
export { EffectConfig } from './models';
export { Effect } from './effect_decorator';
export { getEffectsMetadata } from './effects_metadata';
export { mergeEffects } from './effects_resolver';
Expand Down
10 changes: 10 additions & 0 deletions modules/effects/src/models.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
/**
* Configures an effect creator. See `createEffect`.
*/
export interface EffectConfig {
/**
* Determines if the action emitted by the effect is dispatched to the store.
* If false, effect does not need to return type `Observable<Action>`.
*/
dispatch?: boolean;
/**
* Determines if the effect will be resubscribed if an error occurs in the main actions stream.
*/
resubscribeOnError?: boolean;

This comment has been minimized.

Copy link
@dsebastien

dsebastien Nov 21, 2019

What is the default value for resubscribeOnError and dispatch? It might be nice to mention those in the API docs as well.

}

Expand Down

0 comments on commit 6a4bbcf

Please sign in to comment.