@angular/core

CreateEffectOptions

interface

Options passed to the effect function.

API

  
    interface CreateEffectOptions {}

Injector | undefined

The Injector in which to create the effect.

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

boolean | undefined

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.

true | undefined

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

boolean | undefined

@deprecated

no longer required, signal writes are allowed by default.

string | undefined

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