kobwebx-serialization-kotlinx/com.varabyte.kobweb.browser.http/tryQuery

tryQuery

inline suspend fun <B, T> HttpFetcher.tryQuery(resource: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy<B> = serializer(), noinline transform: suspend Response.() -> T): T?(source)

A serialize-friendly version of tryQuery that accepts a serializable body and logic to convert the response to some desired target object of type T.

A transform callback is provided allowing you to convert the response into a different type. You are generally encouraged to call tryQuery(...) { convert() } over tryQuery(...)?.convert() as the former will ensure that exception handling is covered in that case.

Additionally, if HttpFetcher.logOnError is set to true, any failure will be logged to the console (including the logic in the transform block).

If you do not care about converting the result to some arbitrary type, use the tryQuery version that returns Response? instead. For serialization-aware methods, it is expected that users will rarely, if ever, need this version. Instead, via the Response version, use tryQuery<RequestClass>().bodyAs<ReplyClass>()

inline suspend fun <B> HttpFetcher.tryQuery(resource: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy<B> = serializer()): Response?(source)

Like query but returns null instead of throwing if the request fails.

Additionally, if HttpFetcher.logOnError is set to true, any failure will be logged to the console. By default, this will be true for debug builds and false for release builds.

If you plan to do additional operations on the response and would also like to have logging / exception protection for them, consider using the other tryQuery call which lets you pass in a transform callback. You are generally encouraged to call tryQuery(...) { convert() } over tryQuery(...)?.convert().