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

Package-level declarations

Functions

Link copied to clipboard
inline suspend fun <R> ApiFetcher.delete(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

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

Link copied to clipboard
inline suspend fun <R> ApiFetcher.get(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

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

Link copied to clipboard
inline suspend fun <R> ApiFetcher.head(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

Call HEAD on a target API path with R as the expected return type.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.options(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

Call OPTIONS on a target API path with R as the expected return type.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.patch(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

A serialize-friendly version of patch that doesn't put any type constraints on the body.

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

Call PATCH on a target API path with B as the body type and R as the expected return type.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.post(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

A serialize-friendly version of post that doesn't put any type constraints on the body.

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

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

Link copied to clipboard
inline suspend fun <R> ApiFetcher.put(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R

A serialize-friendly version of put that doesn't put any type constraints on the body.

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

Call PUT on a target API path with B as the body type and R as the expected return type.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.tryDelete(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

Like delete, but returns null if the request failed for any reason.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.tryGet(apiPath: 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 failed for any reason.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.tryHead(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

Like head, but returns null if the request failed for any reason.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.tryOptions(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

Like options, but returns null if the request failed for any reason.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.tryPatch(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

A serialize-friendly version of tryPatch that doesn't put any type constraints on the body.

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

Like patch, but returns null if the request failed for any reason.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.tryPost(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

A serialize-friendly version of tryPost that doesn't put any type constraints on the body.

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

Like post, but returns null if the request failed for any reason.

Link copied to clipboard
inline suspend fun <R> ApiFetcher.tryPut(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?

A serialize-friendly version of tryPut that doesn't put any type constraints on the body.

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

Like put, but returns null if the request failed for any reason.