Query Params
Overview
This store is used to manage the query parameters. It is used to store the query parameters for the current page.
Basic Features
setFromUrl()
Sets the state from the given URL by extracting query parameters and updating the store.
setFromUrl(url: string): void
| Parameter | Type | Description |
|---|---|---|
| url | string | The URL from which to extract params |
addFilter()
Adds a filter to the store's state.
addFilter(filter: LegacyFilter): void
| Parameter | Type | Description |
|---|---|---|
| filter | LegacyFilter | The filter to add |
updateFilter()
Updates the filter with the given value.
updateFilter(filter: LegacyFilter): void
| Parameter | Type | Description |
|---|---|---|
| filter | LegacyFilter | The filter to update |
clearFilter()
Clears the filter.
clearFilter(): void
clearBasket()
Clears the basket from the state.
clearBasket(): void
patch()
Patches the query parameters with the given value.
patch(params: Partial<QueryParamsState>): void
| Parameter | Type | Description |
|---|---|---|
| params | Partial<QueryParamsState> | The parameters to patch with |
getFilter()
Retrieves a filter object based on the provided field or name.
getFilter({ field, name }: { field: string | undefined; name: string | undefined }): Partial<LegacyFilter & { count: number }> | null
| Parameter | Type | Description |
|---|---|---|
| field | string | The field to search for in filters |
| name | string | The name to search for in filters |