element-plus/packages/hooks/use-deprecated/index.ts

35 lines
695 B
TypeScript
Raw Normal View History

import { unref, watch } from 'vue'
import { debugWarn } from '@element-plus/utils'
import type { MaybeRef } from '@vueuse/core'
type DeprecationParam = {
from: string
replacement: string
scope: string
version: string
ref: string
}
export const useDeprecated = (
{ from, replacement, scope, version, ref }: DeprecationParam,
condition: MaybeRef<boolean>
) => {
watch(
() => unref(condition),
(val) => {
if (val) {
debugWarn(
scope,
`API ${from} is about to be deprecated in version ${version}, please use ${replacement} instead.
For more detail, please visit: ${ref}
`
)
}
},
{
immediate: true,
}
)
}