>(
paramConfigMap: QPCMap,
WrappedComponent: React.ComponentType
): React.FC>>
```
### Parameters
- **paramConfigMap** (QPCMap) - Required - Configuration for query parameters.
- **WrappedComponent** (React.ComponentType) - Required - The component to inject props into.
### Returns
A React functional component that injects `query` and `setQuery` props.
### Example
```js
import { withQueryParams, StringParam, NumberParam } from 'use-query-params';
const MyComponent = ({ query, setQuery, ...others }) => {
const { foo, bar } = query;
return foo = {foo}, bar = {bar}
}
export default withQueryParams({ foo: NumberParam, bar: StringParam }, MyComponent);
```
```
--------------------------------
### useQueryParam Hook Signature
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/use-query-params/README.md
The signature for the useQueryParam hook, which reads a single query parameter and returns its decoded value and a setter function.
```typescript
useQueryParam(
name: string,
paramConfig?: QueryParamConfig,
options?: QueryParamOptions
): [
TypeFromDecode,
(newValue: NewValueType, updateType?: UrlUpdateType) => void
]
```
--------------------------------
### Create Enum Array Param
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/serialize-query-params/README.md
Define an array enum parameter that restricts decoded output to a list of allowed values. Use createEnumArrayParam or createEnumDelimitedArrayParam.
```javascript
import { createEnumArrayParam } from 'serialize-query-params';
// feel free to use Enum instead of union types
type Color = 'red' | 'green' | 'blue'
// values other than 'red', 'green' or 'blue' will be decoded as undefined
const ColorArrayEnumParam = createEnumArrayParam(['red', 'green', 'blue'])
```
--------------------------------
### Update Location with Encoded Query
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/serialize-query-params/README.md
Creates a new location object with an updated query string based on provided encoded parameters. Unspecified parameters are dropped.
```javascript
import { updateLocation } from 'serialize-query-params';
// location has search: ?foo=123&bar=abc
const newLocation = updateLocation({ foo: '555' }, location);
// newLocation has search: ?foo=555
// note that unspecified query parameters (bar in this case) are not retained.
```
--------------------------------
### encodeQueryParams
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/serialize-query-params/README.md
Converts query parameter values to strings using configured encode functions, useful for constructing links.
```APIDOC
## encodeQueryParams
### Description
Converts the values in query to strings via the encode functions configured in paramConfigMap. This can be useful for constructing links using decoded query parameters.
### Signature
```typescript
encodeQueryParams(
paramConfigMap: QPCMap,
query: Partial>
): Partial>
```
### Example
```js
import {
encodeQueryParams,
DelimitedArrayParam,
NumberParam,
} from 'serialize-query-params';
import { stringify } from 'query-string';
// encode each parameter according to the configuration
const encodedQuery = encodeQueryParams(
{ foo: NumberParam, bar: DelimitedArrayParam },
{ foo: 123, bar: ['a', 'b'] }
);
// produces: { foo: '123', bar: 'a_b' }
const link = `/?${stringify(encodedQuery)}`;
```
```
--------------------------------
### searchStringToObject
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/serialize-query-params/README.md
Converts a URL search string into an object of query parameters.
```APIDOC
## searchStringToObject
### Description
Default implementation of searchStringToObject powered by URLSearchParams. This converts a search string like `?foo=123&bar=x` to `{ foo: '123', bar: 'x' }`. This is only a very basic version, you may prefer the advanced versions offered by third party libraries like query-string ("parse") or qs.
### Signature
```typescript
function searchStringToObject(searchString: string): EncodedQuery
```
### Example
```js
import { searchStringToObject } from 'serialize-query-params';
const obj = searchStringToObject('?foo=a&bar=x&foo=z');
// -> { foo: ['a', 'z'], bar: 'x'}
```
```
--------------------------------
### objectToSearchString
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/serialize-query-params/README.md
Converts an object of query parameters into a URL search string.
```APIDOC
## objectToSearchString
### Description
Default implementation of objectToSearchString powered by URLSearchParams. Does not support null values. Does not prefix with "?"
This converts an object `{ foo: '123', bar: 'x' }` to a search string `?foo=123&bar=x`
This is only a very basic version, you may prefer the advanced versions offered by third party libraries like query-string ("stringify") or qs.
### Signature
```typescript
function objectToSearchString(encodedParams: EncodedQuery): string
```
### Example
```js
import { objectToSearchString } from 'serialize-query-params';
const obj = objectToSearchString({ foo: ['a', 'z'], bar: 'x' });
// '?foo=a&foo=z&bar=x'
```
```
--------------------------------
### Decode Query Parameters
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/serialize-query-params/README.md
Converts query parameter values from strings to their natural types using configured decode functions. Useful for parsing incoming URL query strings.
```javascript
import {
stringify,
decodeQueryParams,
NumberParam,
DelimitedArrayParam
} from 'serialize-query-params';
// encode each parameter according to the configuration
const decodedQuery = decodeQueryParams(
{ foo: NumberParam, bar: DelimitedArrayParam },
{ foo: '123', bar: 'a_b' }
);
// produces: { foo: 123, bar: ['a', 'b'] }
```
--------------------------------
### decodeQueryParams
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/serialize-query-params/README.md
Converts query parameter values from strings to their natural types using configured decode functions.
```APIDOC
## decodeQueryParams
### Description
Converts the values in query from strings to their natural types via the decode functions configured in paramConfigMap.
### Signature
```typescript
decodeQueryParams(paramConfigMap: QPCMap, encodedQuery: Partial>): DecodedValueMap
```
### Example
```js
import {
stringify,
decodeQueryParams,
NumberParam,
DelimitedArrayParam
} from 'serialize-query-params';
// encode each parameter according to the configuration
const decodedQuery = decodeQueryParams(
{ foo: NumberParam, bar: DelimitedArrayParam },
{ foo: '123', bar: 'a_b' }
);
// produces: { foo: 123, bar: ['a', 'b'] }
```
```
--------------------------------
### withQueryParams HOC Signature
Source: https://github.com/pbeshai/use-query-params/blob/master/packages/use-query-params/README.md
The signature for the withQueryParams Higher-Order Component (HOC), which injects query parameter props into a wrapped React component.
```typescript
withQueryParams>
(paramConfigMap: QPCMap, WrappedComponent: React.ComponentType):
React.FC>>
```
=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.