⬅️ Back to Table of Contents

📄 useArrayEvery

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	4
🟢 Vue Composition API	1
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Vue Composition API
• Functions
• Type Aliases

🛠️ File Location:

📂 packages/shared/useArrayEvery/index.ts

📦 Imports

Name	Source
ComputedRef	vue
MaybeRefOrGetter	vue
computed	vue
toValue	vue

---

Vue Composition API

Name	Type	Reactive Variables	Composables
computed	computed	none	none

---

Functions

useArrayEvery(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: Mayb…): UseArrayEveryReturn

Reactive Array.every

Parameters:

• list any: the array was called upon.
• fn any: a function to test each element.

Returns: undefined true if the fn function returns a truthy value for every element from the array. Otherwise, false.

See: https://vueuse.org/useArrayEvery

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

/**
 * Reactive `Array.every`
 *
 * @see https://vueuse.org/useArrayEvery
 * @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 every element from the array. Otherwise, **false**.
 *
 * @__NO_SIDE_EFFECTS__
 */

Calls:

• computed (from vue)
• toValue(list).every
• fn
• toValue (from vue)

Code

export function useArrayEvery<T>(
  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
  fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown,
): UseArrayEveryReturn {
  return computed(() => toValue(list).every((element, index, array) => fn(toValue(element), index, array)))
}

---

Type Aliases

UseArrayEveryReturn

type UseArrayEveryReturn = ComputedRef<boolean>;

---

Generated by Syntax Scribe