diff --git a/packages/shared/index.ts b/packages/shared/index.ts index 68c277a2b39..ea32ede507e 100644 --- a/packages/shared/index.ts +++ b/packages/shared/index.ts @@ -34,6 +34,7 @@ export * from './until' export * from './useArrayEvery' export * from './useArrayFilter' export * from './useArrayMap' +export * from './useArraySome' export * from './useCounter' export * from './useDateFormat' export * from './useDebounceFn' diff --git a/packages/shared/useArraySome/index.md b/packages/shared/useArraySome/index.md new file mode 100644 index 00000000000..ab3b2dc7816 --- /dev/null +++ b/packages/shared/useArraySome/index.md @@ -0,0 +1,36 @@ +--- +category: Utilities +--- + +# useArraySome + +Reactive `Array.some` + +## Usage + +### Use with array of multiple refs + +```js +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 + +```js +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 +``` diff --git a/packages/shared/useArraySome/index.test.ts b/packages/shared/useArraySome/index.test.ts new file mode 100644 index 00000000000..569895f7384 --- /dev/null +++ b/packages/shared/useArraySome/index.test.ts @@ -0,0 +1,29 @@ +import { ref } from 'vue-demi' +import { useArraySome } from '../useArraySome' + +describe('useArraySome', () => { + it('should be defined', () => { + expect(useArraySome).toBeDefined() + }) + + it('should work with array of refs', () => { + 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) + expect(result.value).toBe(false) + item1.value = 11 + expect(result.value).toBe(true) + }) + + it('should work with reactive array', () => { + const list = ref([0, 2, 4, 6, 8]) + const result = useArraySome(list, i => i > 10) + expect(result.value).toBe(false) + list.value.push(11) + expect(result.value).toBe(true) + }) +}) diff --git a/packages/shared/useArraySome/index.ts b/packages/shared/useArraySome/index.ts new file mode 100644 index 00000000000..6ab295240b6 --- /dev/null +++ b/packages/shared/useArraySome/index.ts @@ -0,0 +1,12 @@ +import type { MaybeComputedRef } from '@vueuse/shared' +import { resolveUnref } from '@vueuse/shared' +import type { ComputedRef } from 'vue-demi' +import { computed } from 'vue-demi' + +export function useArraySome( + list: MaybeComputedRef[]>, + fn: (element: T, index: number, array: MaybeComputedRef[]) => boolean, +): ComputedRef { + const cb = (element: MaybeComputedRef, index: number, array: MaybeComputedRef[]) => fn(resolveUnref(element), index, array) + return computed(() => resolveUnref(list).some(cb)) +}