refactor: add treeshake annotation for Array category

vueuse · antfu · Jul 28, 2025 · Jul 22, 2025 · Jul 22, 2025 · Jul 23, 2025
commit 3cf0213f43ac6ca3e477dfe891ccdd327af41f55
diff --git a/packages/shared/useArrayDifference/index.ts b/packages/shared/useArrayDifference/index.ts
@@ -35,6 +35,8 @@ export function useArrayDifference<T>(
  * @see https://vueuse.org/useArrayDifference
  * @returns - the difference of two array
  * @param args
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayDifference<T>(...args: any[]): UseArrayDifferenceReturn<T> {
   const list: MaybeRefOrGetter<T[]> = args[0]

diff --git a/packages/shared/useArrayEvery/index.ts b/packages/shared/useArrayEvery/index.ts
@@ -11,6 +11,8 @@ export type UseArrayEveryReturn = ComputedRef<boolean>
  * @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__
  */
 export function useArrayEvery<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,

diff --git a/packages/shared/useArrayFilter/index.ts b/packages/shared/useArrayFilter/index.ts
@@ -11,6 +11,8 @@ export type UseArrayFilterReturn<T = any> = ComputedRef<T[]>
  * @param fn - a function that is called for every element of the given `list`. Each time `fn` executes, the returned value is added to the new array.
  *
  * @returns a shallow copy of a portion of the given array, filtered down to just the elements from the given array that pass the test implemented by the provided function. If no elements pass the test, an empty array will be returned.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayFilter<T, S extends T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
@@ -20,6 +22,7 @@ export function useArrayFilter<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
   fn: (element: T, index: number, array: T[]) => unknown,
 ): UseArrayFilterReturn<T>
+/* @__NO_SIDE_EFFECTS__ */
 export function useArrayFilter<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
   fn: (element: T, index: number, array: T[]) => unknown,

diff --git a/packages/shared/useArrayFind/index.ts b/packages/shared/useArrayFind/index.ts
@@ -11,6 +11,8 @@ export type UseArrayFindReturn<T = any> = ComputedRef<T | undefined>
  * @param fn - a function to test each element.
  *
  * @returns the first element in the array that satisfies the provided testing function. Otherwise, undefined is returned.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayFind<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,

diff --git a/packages/shared/useArrayFindIndex/index.ts b/packages/shared/useArrayFindIndex/index.ts
@@ -11,6 +11,8 @@ export type UseArrayFindIndexReturn = ComputedRef<number>
  * @param fn - a function to test each element.
  *
  * @returns the index of the first element in the array that passes the test. Otherwise, "-1".
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayFindIndex<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,

diff --git a/packages/shared/useArrayFindLast/index.ts b/packages/shared/useArrayFindLast/index.ts
@@ -21,6 +21,8 @@ export type UseArrayFindLastReturn<T = any> = ComputedRef<T | undefined>
  * @param fn - a function to test each element.
  *
  * @returns the last element in the array that satisfies the provided testing function. Otherwise, undefined is returned.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayFindLast<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,

diff --git a/packages/shared/useArrayIncludes/index.ts b/packages/shared/useArrayIncludes/index.ts
@@ -21,6 +21,8 @@ export type UseArrayIncludesReturn = ComputedRef<boolean>
  * @see https://vueuse.org/useArrayIncludes
  *
  * @returns true if the `value` is found in the array. Otherwise, false.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayIncludes<T, V = any>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
@@ -37,6 +39,7 @@ export function useArrayIncludes<T, V = any>(
   value: MaybeRefOrGetter<V>,
   options?: UseArrayIncludesOptions<T, V>,
 ): UseArrayIncludesReturn
+/* @__NO_SIDE_EFFECTS__ */
 export function useArrayIncludes<T, V = any>(
   ...args: any[]
 ): UseArrayIncludesReturn {

diff --git a/packages/shared/useArrayJoin/index.ts b/packages/shared/useArrayJoin/index.ts
@@ -11,6 +11,8 @@ export type UseArrayJoinReturn = ComputedRef<string>
  * @param separator - a string to separate each pair of adjacent elements of the array. If omitted, the array elements are separated with a comma (",").
  *
  * @returns a string with all array elements joined. If arr.length is 0, the empty string is returned.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayJoin(
   list: MaybeRefOrGetter<MaybeRefOrGetter<any>[]>,

diff --git a/packages/shared/useArrayMap/index.ts b/packages/shared/useArrayMap/index.ts
@@ -11,6 +11,8 @@ export type UseArrayMapReturn<T = any> = ComputedRef<T[]>
  * @param fn - a function that is called for every element of the given `list`. Each time `fn` executes, the returned value is added to the new array.
  *
  * @returns a new array with each element being the result of the callback function.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayMap<T, U = T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,

diff --git a/packages/shared/useArrayReduce/index.ts b/packages/shared/useArrayReduce/index.ts
@@ -11,6 +11,8 @@ export type UseArrayReducer<PV, CV, R> = (previousValue: PV, currentValue: CV, c
  * @param reducer - a "reducer" function.
  *
  * @returns the value that results from running the "reducer" callback function to completion over the entire array.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayReduce<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
@@ -26,6 +28,8 @@ export function useArrayReduce<T>(
  * @param initialValue - a value to be initialized the first time when the callback is called.
  *
  * @returns the value that results from running the "reducer" callback function to completion over the entire array.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayReduce<T, U>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
@@ -42,6 +46,8 @@ export function useArrayReduce<T, U>(
  * @param args
  *
  * @returns the value that results from running the "reducer" callback function to completion over the entire array.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayReduce<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,

diff --git a/packages/shared/useArraySome/index.ts b/packages/shared/useArraySome/index.ts
@@ -11,6 +11,8 @@ export type UseArraySomeReturn = ComputedRef<boolean>
  * @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 function useArraySome<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,

diff --git a/packages/shared/useArrayUnique/index.ts b/packages/shared/useArrayUnique/index.ts
@@ -24,6 +24,8 @@ export type UseArrayUniqueReturn<T = any> = ComputedRef<T[]>
  * @param list - the array was called upon.
  * @param compareFn
  * @returns A computed ref that returns a unique array of items.
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export function useArrayUnique<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,