chore: consolidate new foundation and archive v1 (#1495)

2026-09-07 12:32:57 -05:00
parent 9a5fbdbda7 5d27700026
commit 127a54fdff
3511 changed files with 727899 additions and 10 deletions
@@ -0,0 +1,63 @@
+---
+category: Array
+---
+
+# useArrayIncludes
+
+Reactive `Array.includes`
+
+## Usage
+
+### Use with reactive array
+
+```ts
+import { useArrayIncludes } from '@vueuse/core';
+
+const list = ref([0, 2, 4, 6, 8]);
+const result = useArrayIncludes(list, 10);
+// result.value: false
+list.value.push(10);
+// result.value: true
+list.value.pop();
+// result.value: false
+```
+
+## Type Declarations
+
+```ts
+export type UseArrayIncludesComparatorFn<T, V> = (
+  element: T,
+  value: V,
+  index: number,
+  array: MaybeRefOrGetter<T>[],
+) => boolean;
+export interface UseArrayIncludesOptions<T, V> {
+  fromIndex?: number;
+  comparator?: UseArrayIncludesComparatorFn<T, V> | keyof T;
+}
+export type UseArrayIncludesReturn = ComputedRef<boolean>;
+/**
+ * Reactive `Array.includes`
+ *
+ * @see https://vueuse.org/useArrayIncludes
+ *
+ * @returns true if the `value` is found in the array. Otherwise, false.
+ *
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function useArrayIncludes<T, V = any>(
+  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
+  value: MaybeRefOrGetter<V>,
+  comparator?: UseArrayIncludesComparatorFn<T, V>,
+): UseArrayIncludesReturn;
+export declare function useArrayIncludes<T, V = any>(
+  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
+  value: MaybeRefOrGetter<V>,
+  comparator?: keyof T,
+): UseArrayIncludesReturn;
+export declare function useArrayIncludes<T, V = any>(
+  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
+  value: MaybeRefOrGetter<V>,
+  options?: UseArrayIncludesOptions<T, V>,
+): UseArrayIncludesReturn;
+```