EffectFn

An effect function

Callable

• EffectFn<T, R>(source: Signal<T>, action: EffectAction<T, R>, options?: EffectOptions): Readonly<{ onDestroy: Signal<void>; onError: Signal<unknown>; onResult: Signal<R>; destroy: any }>
• EffectFn<T, R>(source: Atom<T>, action: EffectAction<T, R>, options?: EffectOptions): Readonly<{ onDestroy: Signal<void>; onError: Signal<unknown>; onResult: Signal<R>; destroy: any }>
• EffectFn<TValues, R>(sources: [...{ [ K in string | number | symbol ]: Atom<TValues[K]> }[]], action: EffectAction<TValues, R>, options?: EffectOptions): Readonly<{ onDestroy: Signal<void>; onError: Signal<unknown>; onResult: Signal<R>; destroy: any }>

---

• Creates a new effect for a signal

  ---

  Type parameters

  • T
  • R

  Parameters

  • source: Signal<T>

  • action: EffectAction<T, R>

  • optionaloptions: EffectOptions

  Returns Readonly<{ onDestroy: Signal<void>; onError: Signal<unknown>; onResult: Signal<R>; destroy: any }>