Skip to content

Function: useFuseSearch()

ts
function useFuseSearch<T>(search, options?): object;

Defined in: packages/valaxy/client/composables/search/useFuseSearch.ts:8

Type Parameters

T

T extends FuseListItem = FuseListItem

Parameters

MaybeRefOrGetter<string>

options?

MaybeRefOrGetter<UseFuseOptions<T>>

Returns

object

fetchFuseListData()

ts
fetchFuseListData: (path?) => Promise<void>;

Parameters

path?

string

Returns

Promise<void>

fuse

ts
fuse: Ref<{
  add: (doc) => void;
  getIndex: () => FuseIndex<T>;
  remove: (predicate) => T[];
  removeAt: (idx) => void;
  search: <R>(pattern, options?) => FuseResult<R>[];
  setCollection: (docs, index?) => void;
}, 
  | Fuse<T>
  | {
  add: (doc) => void;
  getIndex: () => FuseIndex<T>;
  remove: (predicate) => T[];
  removeAt: (idx) => void;
  search: <R>(pattern, options?) => FuseResult<R>[];
  setCollection: (docs, index?) => void;
}>;

results

ts
results: ComputedRef<FuseResult<T>[]>;