Skip to content

useMath

Category
Export Size
178 B
Package
@vueuse/math
Last Changed
3 weeks ago

Reactive Math methods.

Usage

ts
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

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

Source

SourceDocs

Contributors

Anthony Fu
Anthony Fu
Arthur Darkstone
SerKo

Changelog

v14.0.0-alpha.3 on
554b7 - fix: update return types for createTemplatePromise, useMagicKeys, use… (#4963)
v13.6.0 on
d32f8 - refactor: add @__NO_SIDE_EFFECTS__ annotations to all pure functions (#4907)

Released under the MIT License.

Turn AI into a coding partner
Claim 40% off for AIDD Masterclass.
Get discount