Skip to content

⬅️ Back to Table of Contents

📄 tryOnScopeDispose

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 3

📚 Table of Contents

🛠️ File Location:

📂 packages/shared/tryOnScopeDispose/index.ts

📦 Imports

Name Source
Fn ../utils
getCurrentScope vue
onScopeDispose vue

Functions

tryOnScopeDispose(fn: Fn, failSilently: boolean): boolean

Call onScopeDispose() if it's inside an effect scope lifecycle, if not, do nothing

Parameters:

  • fn any: No description
Raw JSDoc
/**
 * Call onScopeDispose() if it's inside an effect scope lifecycle, if not, do nothing
 *
 * @param fn
 */

Calls:

  • getCurrentScope (from vue)
  • onScopeDispose (from vue)
Code
export function tryOnScopeDispose(fn: Fn, failSilently?: boolean): boolean {
  if (getCurrentScope()) {
    onScopeDispose(fn, failSilently)
    return true
  }
  return false
}

Generated by Syntax Scribe