Back to React Router

createSearchParams

docs/api/utils/createSearchParams.md

7.6.2872 B
Original Source

createSearchParams

[MODES: framework, data, declarative]

Summary

Reference Documentation ↗

Creates a URLSearchParams object using the given initializer.

This is identical to new URLSearchParams(init) except it also supports arrays as values in the object form of the initializer instead of just strings. This is convenient when you need multiple values for a given key, but don't want to use an array initializer.

For example, instead of:

tsx
let searchParams = new URLSearchParams([
  ["sort", "name"],
  ["sort", "price"],
]);

you can do:

let searchParams = createSearchParams({
  sort: ['name', 'price']
});

Signature

tsx
createSearchParams(init): URLSearchParams

Params

init

[modes: framework, data, declarative]

No documentation