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

Package-level declarations

Functions

inline suspend fun <R> Response.bodyAs(strategy: DeserializationStrategy<R>): R

inline suspend fun <R> Response.bodyAs(requireOk: Boolean = true, strategy: DeserializationStrategy<R> = serializer()): R

Convert the receiving Response into an object of type R (where that class should be marked @Serializable).

delete

inline suspend fun <R> HttpFetcher.~~delete~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

Call DELETE on a target resource with R as the expected return type.

get

inline suspend fun <R> HttpFetcher.~~get~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

Call GET on a target resource with R as the expected return type.

options

inline suspend fun <R> HttpFetcher.~~options~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

Call DELETE on a target resource with R as the expected return type.

patch

inline suspend fun <R> HttpFetcher.~~patch~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

A serialize-friendly version of patch that has no body but provides a serialized response.

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

A version of patch that accepts a serializable body.

inline suspend fun <B, R> HttpFetcher.~~patch~~(resource: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy = serializer(), responseDeserializer: DeserializationStrategy<R> = serializer()): R

Call PATCH on a target resource with R as the expected return type.

patchBytes

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

A serialize-friendly version of patch that accepts a serializable body and returns its response as a raw byte array.

post

inline suspend fun <R> HttpFetcher.~~post~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

A serialize-friendly version of post that has no body but provides a serialized response.

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

A version of post that accepts a serializable body.

inline suspend fun <B, R> HttpFetcher.~~post~~(resource: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy = serializer(), responseDeserializer: DeserializationStrategy<R> = serializer()): R

Call POST on a target resource with R as the expected return type.

postBytes

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

A serialize-friendly version of post that accepts a serializable body and returns its response as a raw byte array.

put

inline suspend fun <R> HttpFetcher.~~put~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

A serialize-friendly version of put that has no body but provides a serialized response.

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

A version of put that accepts a serializable body.

inline suspend fun <B, R> HttpFetcher.~~put~~(resource: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy = serializer(), responseDeserializer: DeserializationStrategy<R> = serializer()): R

Call PUT on a target resource with R as the expected return type.

putBytes

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

A serialize-friendly version of put that accepts a serializable body and returns its response as a raw byte array.

toRequestBody

fun B.toRequestBody(strategy: SerializationStrategy): RequestBody

tryDelete

inline suspend fun <R> HttpFetcher.~~tryDelete~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

A serialize-friendly version of tryDelete.

tryGet

inline suspend fun <R> HttpFetcher.~~tryGet~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

Like get, but returns null if the request fails or the response can't be deserialized.

tryOptions

inline suspend fun <R> HttpFetcher.~~tryOptions~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

A serialize-friendly version of tryDelete.

tryPatch

inline suspend fun <R> HttpFetcher.~~tryPatch~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

A serialize-friendly version of tryPatch that has no body but provides a serialized response.

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

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

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

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

inline suspend fun <B, R> HttpFetcher.~~tryPatch~~(resource: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy = serializer(), responseDeserializer: DeserializationStrategy<R> = serializer()): R?

Like patch, but returns null if the request fails or the response can't be deserialized.

tryPatchBytes

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

A serialize-friendly version of patch that accepts a serializable body but returns raw bytes instead of a serialized response.

tryPost

inline suspend fun <R> HttpFetcher.~~tryPost~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

A serialize-friendly version of tryPost that has no body but provides a serialized response.

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

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

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

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

inline suspend fun <B, R> HttpFetcher.~~tryPost~~(resource: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy = serializer(), responseDeserializer: DeserializationStrategy<R> = serializer()): R?

Like post, but returns null if the request fails or the response can't be deserialized.

tryPostBytes

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

A version of tryPost that returns its response as a raw byte array.

tryPut

inline suspend fun <R> HttpFetcher.~~tryPut~~(resource: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

A serialize-friendly version of tryPut that has no body but provides a serialized response.

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

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

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

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

inline suspend fun <B, R> HttpFetcher.~~tryPut~~(resource: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy = serializer(), responseDeserializer: DeserializationStrategy<R> = serializer()): R?

Like put, but returns null if the request fails or the response can't be deserialized.

tryPutBytes

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

A serialize-friendly version of put that accepts a serializable body but returns raw bytes instead of a serialized response.