chore: consolidate new foundation and archive v1 (#1495)
This commit is contained in:
@@ -0,0 +1,59 @@
|
||||
---
|
||||
category: Array
|
||||
---
|
||||
|
||||
# useArraySome
|
||||
|
||||
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;
|
||||
```
|
||||
Reference in New Issue
Block a user