> A framework-agnostic RxJS effects implementation

!commitizen
!PRs
!coc-badge
!semantic-release
!styled with prettier

👉 Play with the code on stackblitz

Effects

First, we need to initialize the the library by calling the initEffects() function:

``ts
import { initEffects } from '@ngneat/effects';

initEffects();
`

Actions are created by using the createAction or actionsFactory functions:

`ts
import { actionsFactory, createAction, props } from '@ngneat/effects';

// todos.actions.ts
export interface Todo {
id: string;
name: string;
}

export const addTodo = createAction('[Todos] Add Todo', props<{ title: string }>());

// We recommend using the actions factory to prefix each action
// for better readability and debug purposes when using redux dev tools
export const todoActions = actionsFactory('todo');

// We can declare an action by passing it a type and an optional payload.
export const loadTodos = todoActions.create('Load Todos')
export const addTodo = todoActions.create('Add Todo', props())
`

Next, we need to define the effects, and register them:

`ts
import { createEffect, registerEffects, ofType } from '@ngneat/effects';

export const addTodo$ = createEffect((actions) =>
actions.pipe(
ofType(addTodo),
tap(console.log)
)
);

registerEffects([addTodo$])
`

Finally, we can dispatch actions using the dispatch function:

`ts
import { dispatch } from '@ngneat/effects';

dispatch(addTodo({ title: 'effects' }));
`

Use with React

First, install the package: npm i @ngneat/effects-hook.

Now, we can use the useEffects hook and pass our effects:

`ts
import { useEffects } from '@ngneat/effects-hook';
import { dispatch } from '@ngneat/effects';
import { useEffect } from 'react';

export function TodosPage() {
useEffects([loadTodos$, addTodo$]);

useEffect(() => dispatch(loadTodos()), []);

return (
dispatch(addTodo({ title: 'foo' }))}>
Add

)
}
`

The effects we pass are tied to the component life cycle hook and will be destroyed with the component.

Use with Angular

First, install the package: npm i @ngneat/effects-ng.

Next, create the effect provider:

`ts
import { createEffect } from '@ngneat/effects';

@Injectable({ providedIn: 'root' })
export class TodosEffects {

constructor(private todosApi: TodosApi) {}

loadTodos$ = createEffect(actions => actions.pipe(
ofType(loadTodos),
switchMap((todo) => this.todosApi.loadTodos())
));
}
`

By default, the return value of an effect doesn't dispatch an action. You can get this behavior by passing the { dispatch: false } option as a second parameter.

Then we need to register our the effects in our app module:

`ts
import { EffectsNgModule } from '@ngneat/effects-ng';
import { TodosEffects } from 'todos/todos.effect.ts';

@NgModule({
imports: [
EffectsNgModule.forRoot([TodosEffects], { dispatchByDefault: false }),
]
})
export class AppModule {
}
`
The forRoot method can take as its second parameter the global configuration.
We can set the dispatchByDefault property to true for each effect to dispatch the resulting action. The default is set to false.

As stated above, this behavior can be overwritten on each effect.

In order to register lazily loaded effects use the forFeature method:

`ts
import { EffectsNgModule } from '@ngneat/effects-ng';
import { PostsEffects } from "posts/posts.effect.ts"

@NgModule({
imports: [
EffectsNgModule.forFeature([PostsEffects])
]
})
export class LazyModule {
}
`

The actions can be dispatched by injecting the Actions provider:

`ts
import { Actions } from '@ngneat/effects-ng';

@Component(...)
export class AppComponent {
constructor(private actions: Actions) {}

ngOnInit() {
this.actions.dispatch(loadTodos());
}
}
`

$3

In order to test effect classes and using the actions stream from parameter you can substitute the action stream by a
custom created action stream. It's recommended to only use this feature for testing purposes.

`ts
describe("Effect test", () => {
// use a custom action stream to replace the stream before each test
let customActionsStream: Actions;

beforeEach(() => {
customActionsStream = new Actions();

TestBed.configureTestingModule({
imports: [
EffectsNgModule.forRoot(
[EffectsOne],
{ customActionsStream }
)
]
});
})
})
`

Effect Functions

To use an effect function we first need to create it by using the createEffectFn function:

`ts
import { createEffectFn } from '@ngneat/effects';

export const searchTodoEffect = createEffectFn((searchTerm$: Observable) => {
return searchTerm$.pipe(
debounceTime(300),
switchMap((searchTerm) => fetchTodos({ searchTerm })),
);
});
`

The createEffectFn function takes a callback function which is passed an Observable parameter and returns
an Observable.

$3

First, install the package: npm i @ngneat/effects-hook.

We can register the effect in our component, and call it when we need:

`ts
import { useEffectFn } from '@ngneat/effects-hooks';

function SearchComponent() {
const searchTodo = useEffectFn(searchTodoEffect);

return searchTodo(value) }/>
}
`

Every time the effect is called, its value is pushed into that Observable.

We can also register multiple effects:

`ts
function FooComponent() {
const [addTodo, updateTodo, deleteTodo] = useEffectFn([
addTodoEffect, updateTodoEffect, deleteTodoEffect
]);

return ...
}
`

Use with Angular

First, install the package: npm i @ngneat/effects-ng.

Create an effect class, extends the EffectFn class and use the createEffectFn method to create your effects:

`ts
import { EffectFn } from '@ngneat/effects-ng';

export class TodosEffects extends EffectFn {

searchTodo = this.createEffectFn((searchTerm$: Observable) =>
searchTerm$.pipe(
debounceTime(300),
switchMap((searchTerm) => fetchTodos({ searchTerm })),
);
);
}
`

Inject the effects provider in your component, and call it when you need:

`ts
@Component({
providers: [TodosEffects],
})
export class TodosComponent {
constructor(private todosEffects: TodosEffects) {
}

ngOnInit() {
this.control.valueChanges.subscribe(searchTerm => {
this.todosEffects.searchTodo(searchTerm);
});
}
}
``