SmartNgRX Documentation

Home
Using Smart NgRX
Demo Walkthrough
API
@smarttools/smart-ngrx / Function

loadByIdsEffect

Generic types:T

This is the effect that loads the ids from the service.

Presentation

function loadByIdsEffect(
  effectServiceToken: InjectionToken<EffectService<T>>,
  actions: ActionGroup<T>,
  feature: string,
  entity: string,
): (
  actions$?: Actions<any>,
  effectService?: EffectService<T>,
) => Observable<void>;

Returns

(actions$?: Actions<any>, effectService?: EffectService<T>) => Observable<void> -

the loadByIds effect

Parameters

NameTypeDescription
effectServiceToken
InjectionToken<EffectService<T>>

the effect service token that knows how to load the ids

actions
ActionGroup<T>

the action group for the source provided

feature
string

the feature name this effect is being run for

entity
string

the entity within the feature this effect is being run for