fix(useToFixed): deprecated in favor of usePrecision

close #2015 close #2024
vueuse · Aug 4, 2022 · 790ef40 · 790ef40
1 parent 49c8ac4
commit 790ef40
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 8 deletions.
diff --git a/packages/.vitepress/theme/components/FunctionBadge.vue b/packages/.vitepress/theme/components/FunctionBadge.vue
@@ -29,8 +29,14 @@ const link = computed(() => {
 </script>
 
 <template>
-  <div text="sm" flex="~ gap1" items-center>
-    <a v-bind="link" bg="gray-400/5" p="x-1.5 y-0.5" class="rounded items-center" flex="inline gap-1 none" my-auto>
+  <div
+    text="sm" flex="~ gap1" items-center
+    :class="fn.deprecated ? 'op80 saturate-0' : ''"
+  >
+    <a
+      v-bind="link" bg="gray-400/5" p="x-1.5 y-0.5" class="rounded items-center" flex="inline gap-1 none" my-auto
+      :class="fn.deprecated ? 'line-through !decoration-solid' : ''"
+    >
       <span v-html="styledName(fn.name)" />
       <i v-if="fn.external" i-carbon-launch class="opacity-80 text-xs" />
     </a>

diff --git a/packages/math/index.ts b/packages/math/index.ts
@@ -11,6 +11,7 @@ export * from './useFloor'
 export * from './useMath'
 export * from './useMax'
 export * from './useMin'
+export * from './usePrecision'
 export * from './useProjection'
 export * from './useRound'
 export * from './useSum'

diff --git a/packages/math/useToFixed/index.md b/packages/math/useToFixed/index.md
@@ -1,7 +1,12 @@
 ---
 category: '@Math'
+deprecated: true
 ---
 
+::: warning
+**Deprecated**. Please use `usePrecision` instead.
+:::
+
 # useToFixed
 
 Reactive `toFixed`.

diff --git a/packages/math/useToFixed/index.ts b/packages/math/useToFixed/index.ts
@@ -3,16 +3,14 @@ import { computed } from 'vue-demi'
 import type { MaybeComputedRef } from '@vueuse/shared'
 import { resolveUnref } from '@vueuse/shared'
 
-/**
- * Reactive `toFixed`
- *
- * @see https://vueuse.org/useToFixed
- */
 export interface FixedTypes {
   type?: 'string' | 'number'
   math?: 'floor' | 'ceil' | 'round'
 }
 
+/**
+ * @deprecated use `usePrecision` instead
+ */
 export function useToFixed(
   value: MaybeComputedRef<number | string>,
   digits: MaybeComputedRef<number>,

diff --git a/packages/metadata/scripts/update.ts b/packages/metadata/scripts/update.ts
@@ -104,7 +104,7 @@ export async function readMetadata() {
       fn.category = ['core', 'shared'].includes(pkg.name) ? category : `@${pkg.display}`
       fn.description = description
 
-      if (description.includes('DEPRECATED'))
+      if (description.includes('DEPRECATED') || frontmatter.deprecated)
         fn.deprecated = true
 
       if (alias?.length)