useArrayIncludes

类别

Array

导出体积

344 B

上次更改

2 months ago

响应式 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

}
export type UseArrayIncludesReturn
 = ComputedRef
<boolean>
/**
 * 响应式 `Array.includes`
 *
 * @see https://vueuse.org/useArrayIncludes
 *
 * @returns 如果在数组中找到了 `value`，则返回 true。否则返回 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