kotlin-tanstack-react-router/src/jsMain/kotlin/tanstack/react/router/useSearch.kt

@file:JsModule("@tanstack/react-router")

package tanstack.react.router

import js.objects.JsPlainObject
import tanstack.router.core.RouteId
import tanstack.router.core.Search

@JsPlainObject
internal external interface UseSearchOptions<T> {
    val from: RouteId? /* RoutePath */
    val strict: Boolean?
    val select: Select<Search, T>?
    val structuralSharing: Boolean?
    val shouldThrow: Boolean?
}

/**
 * Read and select the current route's search parameters with type-safety.
 *
 * Options:
 * - `from`/`strict`: Control which route's search is read and how strictly it's typed
 * - `select`: Map the search object to a derived value for render optimization
 * - `structuralSharing`: Enable structural sharing for stable references
 * - `shouldThrow`: Throw when the route is not found (strict contexts)
 *
 * [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/useSearchHook)
 *
 * @return The search object (or selected value) for the matched route.
 */
internal external fun <T> useSearch(
    options: UseSearchOptions<T>,
): T