onScopeDispose() — vue Function Reference

Architecture documentation for the onScopeDispose() function in effectScope.ts from the vue codebase.

Function typescript VueCore GlobalAPI

Entity Profile

VueCore→ GlobalAPI→ onScopeDispose() — vue Function Reference

Dependency Diagram

graph TD
  c525cfd0_d14e_1582_6221_2e2a4d348f34["onScopeDispose()"]
  2201dcb0_bcf7_bce0_da13_64df866d683f["effectScope.ts"]
  c525cfd0_d14e_1582_6221_2e2a4d348f34 -->|defined in| 2201dcb0_bcf7_bce0_da13_64df866d683f
  style c525cfd0_d14e_1582_6221_2e2a4d348f34 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/v3/reactivity/effectScope.ts lines 128–137

export function onScopeDispose(fn: () => void) {
  if (activeEffectScope) {
    activeEffectScope.cleanups.push(fn)
  } else if (__DEV__) {
    warn(
      `onScopeDispose() is called when there is no active effect scope` +
        ` to be associated with.`
    )
  }
}