1---
2category: '@Integrations'
3---
4 
5# useFuse
6 
7Easily implement fuzzy search using a composable with [Fuse.js](https://github.com/krisk/fuse).
8 
9From the Fuse.js website:
10 
11> What is fuzzy searching?
12>
13> Generally speaking, fuzzy searching (more formally known as approximate string matching) is the technique of finding strings that are approximately equal to a given pattern (rather than exactly).
14 
15## Install Fuse.js as a peer dependency
16 
17### NPM
18 
19```bash
20npm install fuse.js@^7
21```
22 
23### Yarn
24 
25```bash
26yarn add fuse.js
27```
28 
29## Usage
30 
31```ts
32import { useFuse } from '@vueuse/integrations/useFuse'
33import { shallowRef } from 'vue'
34 
35const data = [
36  'John Smith',
37  'John Doe',
38  'Jane Doe',
39  'Phillip Green',
40  'Peter Brown',
41]
42 
43const input = shallowRef('Jhon D')
44 
45const { results } = useFuse(input, data)
46 
47/*
48 * Results:
49 *
50 * { "item": "John Doe", "index": 1 }
51 * { "item": "John Smith", "index": 0 }
52 * { "item": "Jane Doe", "index": 2 }
53 *
54 */
55```
56 
57## Type Declarations
58 
59```ts
60export type FuseOptions<T> = IFuseOptions<T>
61export interface UseFuseOptions<T> {
62  fuseOptions?: FuseOptions<T>
63  resultLimit?: number
64  matchAllWhenSearchEmpty?: boolean
65}
66export interface UseFuseReturn<DataItem> {
67  fuse: Ref<Fuse<DataItem>>
68  results: ComputedRef<FuseResult<DataItem>[]>
69}
70export declare function useFuse<DataItem>(
71  search: MaybeRefOrGetter<string>,
72  data: MaybeRefOrGetter<DataItem[]>,
73  options?: MaybeRefOrGetter<UseFuseOptions<DataItem>>,
74): UseFuseReturn<DataItem>
75```
76