VueUseuseToNumber
Reactively convert a string ref to number.
Usage
ts
import { useToNumber } from '@vueuse/core'
const str = ref('123')
const number = useToNumber(str)
number.value // 123
import { useToNumber } from '@vueuse/core'
const str = ref('123')
const number = useToNumber(str)
number.value // 123
Type Declarations
typescript
export interface UseToNumberOptions {
/**
* Method to use to convert the value to a number.
*
* @default 'parseFloat'
*/
method?: "parseFloat" | "parseInt"
/**
* The base in mathematical numeral systems passed to `parseInt`.
* Only works with `method: 'parseInt'`
*/
radix?: number
/**
* Replace NaN with zero
*
* @default false
*/
nanToZero?: boolean
}
/**
* Computed reactive object.
*/
export declare function useToNumber(
value: MaybeComputedRef<number | string>,
options?: UseToNumberOptions
): ComputedRef<number>
export interface UseToNumberOptions {
/**
* Method to use to convert the value to a number.
*
* @default 'parseFloat'
*/
method?: "parseFloat" | "parseInt"
/**
* The base in mathematical numeral systems passed to `parseInt`.
* Only works with `method: 'parseInt'`
*/
radix?: number
/**
* Replace NaN with zero
*
* @default false
*/
nanToZero?: boolean
}
/**
* Computed reactive object.
*/
export declare function useToNumber(
value: MaybeComputedRef<number | string>,
options?: UseToNumberOptions
): ComputedRef<number>
Source
Contributors
Anthony Fu