⬅️ Back to Table of Contents

📄 useArrayDifference

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	4
🟢 Vue Composition API	3
📐 Interfaces	1
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Vue Composition API
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/shared/useArrayDifference/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
computed	computed	none	none
computed	computed	none	none

---

Functions

useArrayDifference(list: MaybeRefOrGetter<T[]>, values: MaybeRefOrGetter<T[]>, key: keyof T, options: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T>

Parameters:

• list MaybeRefOrGetter<T[]>
• values MaybeRefOrGetter<T[]>
• key keyof T
• options UseArrayDifferenceOptions

Returns: UseArrayDifferenceReturn<T>

Code

export function useArrayDifference<T>(
  list: MaybeRefOrGetter<T[]>,
  values: MaybeRefOrGetter<T[]>,
  key?: keyof T,
  options?: UseArrayDifferenceOptions,
): UseArrayDifferenceReturn<T>

defaultComparator(value: T, othVal: T): boolean

Parameters:

• value T
• othVal T

Returns: boolean

Code

function defaultComparator<T>(value: T, othVal: T) {
  return value === othVal
}

---

Interfaces

UseArrayDifferenceOptions

Interface Code

export interface UseArrayDifferenceOptions {
  /**
   * Returns asymmetric difference
   *
   * @see https://en.wikipedia.org/wiki/Symmetric_difference
   * @default false
   */
  symmetric?: boolean
}

Properties

Name	Type	Optional	Description
symmetric	boolean	✓	not shown

---

Type Aliases

UseArrayDifferenceReturn<T = any>

type UseArrayDifferenceReturn<T = any> = ComputedRef<T[]>;

---

Generated by Syntax Scribe