Skip to content
On this page

useMath

Category
Export Size
274 B
Package
@vueuse/math
Last Changed
2 months ago

Reactive Math methods.

Usage

import { useMath } from '@vueuse/math'

const base = ref(2)
const exponent = ref(3)
const result = useMath('pow', base, exponent) // Ref<8>

const num = ref(2)
const root = useMath('sqrt', num) // Ref<1.4142135623730951>

num.value = 4
console.log(root.value) // 2
import { useMath } from '@vueuse/math'

const base = ref(2)
const exponent = ref(3)
const result = useMath('pow', base, exponent) // Ref<8>

const num = ref(2)
const root = useMath('sqrt', num) // Ref<1.4142135623730951>

num.value = 4
console.log(root.value) // 2

Type Declarations

export declare type UseMathKeys = keyof {
  [K in keyof Math as Math[K] extends (...args: any) => any
    ? K
    : never]: unknown
}
/**
 * Reactive `Math` methods.
 *
 * @see https://vueuse.org/useMath
 */
export declare function useMath<K extends keyof Math>(
  key: K,
  ...args: ArgumentsType<Reactified<Math[K], true>>
): ReturnType<Reactified<Math[K], true>>
export declare type UseMathKeys = keyof {
  [K in keyof Math as Math[K] extends (...args: any) => any
    ? K
    : never]: unknown
}
/**
 * Reactive `Math` methods.
 *
 * @see https://vueuse.org/useMath
 */
export declare function useMath<K extends keyof Math>(
  key: K,
  ...args: ArgumentsType<Reactified<Math[K], true>>
): ReturnType<Reactified<Math[K], true>>

Source

SourceDocs

Contributors

Changelog

v9.0.0-beta.0 on 7/17/2022
aa3fd - feat: new function (#1935)

Released under the MIT License.