kobweb-core/com.varabyte.kobweb.browser/ApiFetcher

ApiFetcher

class ApiFetcher(window: Window)(source)

A class which makes it easier to access a Kobweb API endpoint, instead of using Window.fetch directly.

This class works by wrapping Window.http but specifically for Kobweb API calls (URLs which are prefixed with "/api/").

Constructors

ApiFetcher

constructor(window: Window)

Properties

logOnError

var logOnError: Boolean

If true, when using any of the "try" methods, logs any errors, if they occur, to the console.

Functions

delete

suspend fun delete(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response

Call DELETE on a target API path.

deleteBytes

suspend fun ~~deleteBytes~~(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call DELETE on a target API path, returning the response body as a raw array of bytes.

get

suspend fun get(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response

Call GET on a target API path.

getBytes

suspend fun ~~getBytes~~(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call GET on a target API path, returning the response body as a raw array of bytes.

head

suspend fun head(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response

Call HEAD on a target API path.

options

suspend fun options(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response

Call OPTIONS on a target API path.

optionsBytes

suspend fun ~~optionsBytes~~(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call OPTIONS on a target API path, returning the response body as a raw array of bytes.

patch

suspend fun patch(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response

Call PATCH on a target API path.

patchBytes

suspend fun ~~patchBytes~~(apiPath: String, body: ByteArray? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call PATCH on a target API path, returning the response body as a raw array of bytes.

post

suspend fun post(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response

Call POST on a target API path.

postBytes

suspend fun ~~postBytes~~(apiPath: String, body: ByteArray? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call POST on a target API path, returning the response body as a raw array of bytes.

put

suspend fun put(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response

Call PUT on a target API path.

putBytes

suspend fun ~~putBytes~~(apiPath: String, body: ByteArray? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call PUT on a target API path, returning the response body as a raw array of bytes.

tryDelete

suspend fun tryDelete(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response?

Like delete, but returns null if the request fails.

suspend fun <T> tryDelete(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, transform: suspend Response.() -> T): T?

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

tryDeleteBytes

suspend fun ~~tryDeleteBytes~~(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray?

Like deleteBytes, but returns null if the request fails or its body can't be read.

tryGet

suspend fun tryGet(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response?

Like get, but returns null if the request fails.

suspend fun <T> tryGet(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, transform: suspend Response.() -> T): T?

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

tryGetBytes

suspend fun ~~tryGetBytes~~(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray?

Like getBytes, but returns null if the request fails or its body can't be read.

tryHead

suspend fun tryHead(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response?

Like head, but returns null if the request fails.

suspend fun <T> tryHead(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, transform: suspend Response.() -> T): T?

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

tryOptions

suspend fun tryOptions(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response?

Like options, but returns null if the request fails.

suspend fun <T> tryOptions(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, transform: suspend Response.() -> T): T?

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

tryOptionsBytes

suspend fun ~~tryOptionsBytes~~(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray?

Like optionsBytes, but returns null if the request fails or its body can't be read.

tryPatch

suspend fun tryPatch(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response?

Like patch, but returns null if the request fails.

suspend fun <T> tryPatch(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, transform: suspend Response.() -> T): T?

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

tryPatchBytes

suspend fun ~~tryPatchBytes~~(apiPath: String, body: ByteArray? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray?

Like patchBytes, but returns null if the request fails or its body can't be read.

tryPost

suspend fun tryPost(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response?

Like post, but returns null if the request fails.

suspend fun <T> tryPost(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, transform: suspend Response.() -> T): T?

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

tryPostBytes

suspend fun ~~tryPostBytes~~(apiPath: String, body: ByteArray? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray?

Like postBytes, but returns null if the request fails or its body can't be read.

tryPut

suspend fun tryPut(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): Response?

Like put, but returns null if the request fails.

suspend fun <T> tryPut(apiPath: String, body: RequestBody? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, transform: suspend Response.() -> T): T?

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

tryPutBytes

suspend fun ~~tryPutBytes~~(apiPath: String, body: ByteArray? = null, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray?

Like putBytes, but returns null if the request fails or its body can't be read.