main.react.router.dom.createSearchParams.kt Maven / Gradle / Ivy

// Automatically generated - do not modify!

@file:JsModule("react-router-dom")
@file:JsNonModule

package react.router.dom

/**
 * 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:
 *
 *   let searchParams = new URLSearchParams([
 *     ['sort', 'name'],
 *     ['sort', 'price']
 *   ]);
 *
 * you can do:
 *
 *   let searchParams = createSearchParams({
 *     sort: ['name', 'price']
 *   });
 */
external fun createSearchParams(
    init: URLSearchParamsInit = definedExternally,
): org.w3c.dom.url.URLSearchParams