Skip to main content
Version: 11.14.0

Query Params

The QueryParamsStore manages the current URL query parameters (search text, filters, page, basket, etc.).

Methods

setFromUrl()

Parses a URL and updates the store state from its query parameters.

setFromUrl(url: string): void
NameTypeRequiredDescription
urlstringThe URL from which to extract query parameters.

addFilter()

Adds a filter to the current state.

addFilter(filter: LegacyFilter): void
NameTypeRequiredDescription
filterLegacyFilterThe filter to add.

updateFilter()

Updates an existing filter in the store.

updateFilter(filter: LegacyFilter): void
NameTypeRequiredDescription
filterLegacyFilterThe updated filter.

clearFilter()

Removes all active filters.

clearFilter(): void

clearBasket()

Removes the basket from the state.

clearBasket(): void

patch()

Merges the provided partial state into the current state.

patch(params: Partial<QueryParamsState>): void
NameTypeRequiredDescription
paramsPartial<QueryParamsState>The parameters to merge.

getFilter()

Retrieves a filter by field or name.

getFilter({ field, name }: { field: string | undefined; name: string | undefined }): Partial<LegacyFilter & { count: number }> | null
NameTypeRequiredDescription
fieldstring | undefinedThe field key to search for.
namestring | undefinedThe filter name to search for.

Returns Partial<LegacyFilter & { count: number }> | null — the matching filter or null.