Interface GatedEffectOptions

Options that control the behavior of gatedEffect.

interface GatedEffectOptions {
    allowSignalWrites?: boolean;
    debugName?: string;
    filter?: () => boolean;
    forceRoot?: true;
    injector?: Injector;
    manualCleanup?: boolean;
    start?: () => boolean;
    times?: number;
    until?: () => boolean;
}

Hierarchy

  • CreateEffectOptions
    • GatedEffectOptions

Properties

allowSignalWrites? debugName? filter? forceRoot? injector? manualCleanup? start? times? until?

Properties

OptionalallowSignalWrites

allowSignalWrites?: boolean

Deprecated

no longer required, signal writes are allowed by default.

OptionaldebugName

debugName?: string

A debug name for the effect. Used in Angular DevTools to identify the effect.

Optionalfilter

filter?: () => boolean

Prevents execution of the effect if this returns false.

OptionalforceRoot

forceRoot?: true

Always create a root effect (which is scheduled as a microtask) regardless of whether effect is called within a component.

Optionalinjector

injector?: Injector

The Injector in which to create the effect.

If this is not provided, the current injection context will be used instead (via inject).

OptionalmanualCleanup

manualCleanup?: boolean

Whether the effect should require manual cleanup.

If this is false (the default) the effect will automatically register itself to be cleaned up with the current DestroyRef.

Optionalstart

start?: () => boolean

A condition that will prevent the effect from running until it is true.
Once it is true once, it will not be checked again.

Optionaltimes

times?: number

The number of times the effect should run.
Only increments if the effect function is run, so occasions where filter or start return false aren't counted.
If until is also set, then whichever comes first will terminate the effect.

Optionaluntil

until?: () => boolean

A condition that will terminate the effect.
If times is also set, then whichever comes first will terminate the effect.

Settings

Member Visibility

On This Page

Properties