createFilter API

API reference for the createFilter composable.

Explore these related pages for additional context and usage patterns.

(options?: FilterOptions) => E

Creates a filter context with pre-configured options.

(_options?: FilterContextOptions) => ContextTrinity<E>

Creates a filter context with dependency injection support.

(namespace?: string) => E

Returns the current filter context from dependency injection.

FilterFunction | undefined

string[] | undefined

FilterMode | undefined

FilterMode

The filter mode

string[] | undefined

Keys to filter on for object items

FilterFunction | undefined

Custom filter function

ShallowRef<Primitive | Primitive[]>

Current query ref

<T extends Z>(query: FilterQuery, items: MaybeRefOrGetter<T[]>) => FilterResult<T>

Apply filter to an array of items