useArrayIncludes

分类

数组

导出大小

362 B

最后更改

5 天前

响应式的 Array.includes

用法

与响应式数组一起使用

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

类型声明

显示类型声明

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
}
/**
 * Reactive `Array.includes`
 *
 * @see https://vueuse.org.cn/useArrayIncludes
 *
 * @returns true if the `value` is found in the array. Otherwise, false.
 */
export declare function useArrayIncludes<T, V = any>(
  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
  value: MaybeRefOrGetter<V>,
  comparator?: UseArrayIncludesComparatorFn<T, V>,
): ComputedRef<boolean>
export declare function useArrayIncludes<T, V = any>(
  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
  value: MaybeRefOrGetter<V>,
  comparator?: keyof T,
): ComputedRef<boolean>
export declare function useArrayIncludes<T, V = any>(
  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
  value: MaybeRefOrGetter<V>,
  options?: UseArrayIncludesOptions<T, V>,
): ComputedRef<boolean>

源码

源码 • 文档

贡献者

Anthony Fu

Anthony Fu

IlyaL

丶远方

更新日志

v12.8.0 于 2025/3/5

7432f - feat(types): 弃用 MaybeRef 和 MaybeRefOrGetter，支持 Vue 原生 (#4636)

v12.3.0 于 2025/1/2

59f75 - feat(toValue): 弃用来自 @vueuse/shared 的 toValue，支持 Vue 原生

v12.0.0-beta.1 于 2024/11/21

0a9ed - feat!: 移除 Vue 2 支持，优化包并清理 (#4349)

v10.0.0-beta.4 于 2023/4/13

4d757 - feat(types)!: 将 MaybeComputedRef 重命名为 MaybeRefOrGetter

0a72b - feat(toValue): 将 resolveUnref 重命名为 toValue

v10.0.0-beta.0 于 2023/3/14

4d6bc - feat: 新函数 (#2708)