ray-template/src/utils/vue/effectDispose.ts

/**
 *
 * @author Ray <https://github.com/XiaoDaiGua-Ray>
 *
 * @date 2023-11-10
 *
 * @workspace ray-template
 *
 * @remark 今天也是元气满满撸代码的一天
 */

import { getCurrentScope, onScopeDispose } from 'vue'

import type { AnyFC } from '@/types/modules/utils'

/**
 *
 * @param fc effect 作用域卸载时需执行函数
 *
 * @remark 返回 true 表示获取到 effect 作用域并且卸载；false 表示未存在 effect 作用域
 */
export function effectDispose(fc: AnyFC) {
  if (getCurrentScope()) {
    onScopeDispose(fc)

    return true
  }

  return false
}