useToNumber

分类

导出大小

213 B

上次更改

3 个月前

将字符串 ref 响应式地转换为数字。

用法

import { useToNumber
 } from '@vueuse/core'
import { shallowRef
 } from 'vue'

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

number
.value
 // 123

类型声明

export interface UseToNumberOptions {
  /**
   * Method to use to convert the value to a number.
   *
   * Or a custom function for the conversion.
   *
   * @default 'parseFloat'
   */
  method
?: "parseFloat" | "parseInt" | ((value
: string | number) => number)
  /**
   * The base in mathematical numeral systems passed to `parseInt`.
   * Only works with `method: 'parseInt'`
   */
  radix
?: number
  /**
   * Replace NaN with zero
   *
   * @default false
   */
  nanToZero
?: boolean
}
/**
 * Reactively convert a string ref to number.
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useToNumber
(
  value
: MaybeRefOrGetter
<number | string>,
  options
?: UseToNumberOptions,
): ComputedRef
<number>