⬅️ Back to Table of Contents

📄 useSorted

📊 Analysis Summary

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

📚 Table of Contents

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

🛠️ File Location:

📂 packages/core/useSorted/index.ts

📦 Imports

Name	Source
MaybeRefOrGetter	vue
Ref	vue
computed	vue
isRef	vue
toValue	vue
watchEffect	vue

---

Vue Composition API

Name	Type	Reactive Variables	Composables
computed	computed	none	none

---

Functions

useSorted(source: MaybeRefOrGetter<T[]>, compareFn: UseSortedCompareFn<T>): Ref<T[]>

reactive sort array

See: https://vueuse.org/useSorted

Raw JSDoc

/**
 * reactive sort array
 *
 * @see https://vueuse.org/useSorted
 */

Code

export function useSorted<T = any>(source: MaybeRefOrGetter<T[]>, compareFn?: UseSortedCompareFn<T>): Ref<T[]>

defaultSortFn(source: T[], compareFn: UseSortedCompareFn<T>): T[]

Parameters:

• source T[]
• compareFn UseSortedCompareFn<T>

Returns: T[]

Calls:

• source.sort

Code

<T>(source: T[], compareFn: UseSortedCompareFn<T>): T[] => source.sort(compareFn)

defaultCompare(a: number, b: number): number

Parameters:

• a number
• b number

Returns: number

Code

(a, b) => a - b

---

Interfaces

UseSortedOptions<T = any>

Interface Code

export interface UseSortedOptions<T = any> {
  /**
   * sort algorithm
   */
  sortFn?: UseSortedFn<T>
  /**
   * compare function
   */
  compareFn?: UseSortedCompareFn<T>
  /**
   * change the value of the source array
   * @default false
   */
  dirty?: boolean
}

Properties

Name	Type	Optional	Description
sortFn	UseSortedFn<T>	✓	not shown
compareFn	UseSortedCompareFn<T>	✓	not shown
dirty	boolean	✓	not shown

---

Type Aliases

UseSortedCompareFn<T = any>

type UseSortedCompareFn<T = any> = (a: T, b: T) => number;

UseSortedFn<T = any>

type UseSortedFn<T = any> = (arr: T[], compareFn: UseSortedCompareFn<T>) => T[];

---

Generated by Syntax Scribe