Skip to content

useToNumber

类别
导出体积
223 B
上次更改
last week

将字符串 ref 转换为数字。

使用方法

ts
import { useToNumber } from '@vueuse/core'

const str = ref('123')
const number = useToNumber(str)

number.value // 123

类型声明

typescript
export interface UseToNumberOptions {
  /**
   * 用于将值转换为数字的方法。
   *
   * Or a custom function for the conversion.
   *
   * @default 'parseFloat'
   */
  method?: "parseFloat" | "parseInt" | ((value: string | number) => number)
  /**
   * 传递给 `parseInt` 的数学数字系统的基数。
   * 仅适用于 `method: 'parseInt'`
   */
  radix?: number
  /**
   * 将 NaN 替换为零
   *
   * @default false
   */
  nanToZero?: boolean
}
/**
 * 将字符串 ref 转换为数字。
 */
export declare function useToNumber(
  value: MaybeRefOrGetter<number | string>,
  options?: UseToNumberOptions,
): ComputedRef<number>

源码

源码文档

贡献者

Anthony Fu
一纸忘忧
Anthony Fu
btea
_Ghosteye

更新日志

v12.3.0 on 1/2/2025
635bb - feat: method support custom function (#4441)
59f75 - feat(toValue): deprecate toValue from @vueuse/shared in favor of Vue's native
v12.0.0-beta.1 on 11/21/2024
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)
v10.0.0-beta.4 on 4/13/2023
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter
0a72b - feat(toValue): rename resolveUnref to toValue