Skip to content

useArraySome

Category
Export Size
135 B
Last Changed
2 weeks ago

Reactive Array.some

Usage

Use with array of multiple refs

ts
import { 
useArraySome
} from '@vueuse/core'
const
item1
=
ref
(0)
const
item2
=
ref
(2)
const
item3
=
ref
(4)
const
item4
=
ref
(6)
const
item5
=
ref
(8)
const
list
= [
item1
,
item2
,
item3
,
item4
,
item5
]
const
result
=
useArraySome
(
list
,
i
=>
i
> 10)
// result.value: false
item1
.
value
= 11
// result.value: true

Use with reactive array

ts
import { 
useArraySome
} from '@vueuse/core'
const
list
=
ref
([0, 2, 4, 6, 8])
const
result
=
useArraySome
(
list
,
i
=>
i
> 10)
// result.value: false
list
.
value
.
push
(11)
// result.value: true

Type Declarations

ts
export type 
UseArraySomeReturn
=
ComputedRef
<boolean>
/** * Reactive `Array.some` * * @see https://vueuse.org/useArraySome * @param list - the array was called upon. * @param fn - a function to test each element. * * @returns **true** if the `fn` function returns a **truthy** value for any element from the array. Otherwise, **false**. * * @__NO_SIDE_EFFECTS__ */ export declare function
useArraySome
<
T
>(
list
:
MaybeRefOrGetter
<
MaybeRefOrGetter
<
T
>[]>,
fn
: (
element
:
T
,
index
: number,
array
:
MaybeRefOrGetter
<
T
>[]) => unknown,
):
UseArraySomeReturn

Source

SourceDocs

Contributors

Anthony Fu
Anthony Fu
SerKo
Robin
IlyaL
Levi (Nguyễn Lương Huy)
Levi (Nguyễn Lương Huy)

Changelog

d32f8 - refactor: add @__NO_SIDE_EFFECTS__ annotations to all pure functions (#4907)
c1d6e - feat(shared): ensure return types exists (#4659)
7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)
59f75 - feat(toValue): deprecate toValue from @vueuse/shared in favor of Vue's native
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter
0a72b - feat(toValue): rename resolveUnref to toValue

Released under the MIT License.