Class Effect

An effect is called once on construction and then again every time a recorded dependency has changed. Internally this is simply an observed ComputedSignal.

Implements

Destroyable

Index

Constructors

Methods

Constructors

constructor

new Effect(fn: EffectFunction): Effect
Creates an effect calling the given function once immediately and then again every time a recorded dependency has changed.
Parameters
- fn: EffectFunction
  The effect function to run. Can optionally return a cleanup function which is called before effect function is called again and on effect destruction.
Returns Effect
- Defined in Effect.ts:34

Methods

destroy

destroy(): void
Destroys the effect. This runs the cleanup function if returned by the last call of the effect function and then unsubscribes and destroys the internal computed signal.

Returns void
Implementation of Destroyable.destroy
- Defined in Effect.ts:50