miniprogram-setup/src/componentLifecycle.ts

小程序支持 setup 选项

import { getCurrentInstance } from './instance'
import { forEachObj } from './shared'
import { useAutoUpdate } from './useAutoUpdate'

type Fn = (...args: any[]) => void

export interface LifecycleStore {
  ready: Map<any, Fn[]>
  moved: Map<any, Fn[]>
  detached: Map<any, Fn[]>
  error: Map<any, Fn[]>
}

let lifecycleStore: LifecycleStore | null = null

/**
 * 在组件在视图层布局完成后执行
 *
 * 最低基础库版本：[`2.2.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
 */
export const onReady = (handler: () => void) => registerComponentLifecyle('ready', handler)

/**
 * 在组件实例被移动到节点树另一个位置时执行
 *
 * 最低基础库版本：[`2.2.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
 */
export const onMoved = (handler: () => void) => registerComponentLifecyle('moved', handler)

/**
 * 在组件实例被从页面节点树移除时执行
 *
 * 最低基础库版本：[`2.2.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
 */
export const onDetached = (handler: () => void) => registerComponentLifecyle('detached', handler)

/**
 * 每当组件方法抛出错误时执行
 *
 * 最低基础库版本：[`2.4.1`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
 */
export const onError = (handler: (err: Error) => void) =>
  registerComponentLifecyle('error', handler)

export const getLifecycleStore = (): LifecycleStore =>
  lifecycleStore != null
  || (lifecycleStore = {
    ready: new Map(),
    moved: new Map(),
    detached: new Map(),
    error: new Map(),
  } as any)

export const emptyLifecycleStore = (instance: any) => {
  if (lifecycleStore != null) {
    forEachObj(lifecycleStore, (map: Map<any, any>) => {
      map.delete(instance)
    })
  }
}

export function registerComponentLifecyle(
  type: keyof LifecycleStore,
  handler: (...args: any[]) => void,
) {
  const map = lifecycleStore?.[type]
  if (map != null) {
    let list: any = map.get(getCurrentInstance())
    if (list != null) {
      list.push(useAutoUpdate(handler))
    }
    else {
      list = []
      map.set(getCurrentInstance(), list)
      list.push(useAutoUpdate(handler))
    }
  }
}