Class EffectScope

Index

Constructors

Properties

cleanups detached effects parent scopes

Accessors

Methods

off on run stop

Constructors

constructor

new EffectScope(detached?): EffectScope
Parameters
- detached: boolean = false
Returns EffectScope

Properties

`Internal` cleanups

cleanups: (() => void)[] = []

Type declaration

- (): void
- Returns void

detached

detached: boolean = false

`Internal` effects

effects: ReactiveEffect<any>[] = []

`Internal` parent

parent: EffectScope

only assigned by undetached scope

`Internal` scopes

scopes: EffectScope[]

record undetached scopes

Accessors

active

get active(): boolean
Returns boolean

Methods

off

off(): void
Internal
This should only be called on non-detached scopes

Returns void

on

on(): void
Internal
This should only be called on non-detached scopes

Returns void

run

run<T>(fn): T
Type Parameters
- T
Parameters
- fn: (() => T)
  - - (): T
    - Returns T
Returns T

stop

stop(fromParent?): void
Parameters
- Optional fromParent: boolean
Returns void