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, log 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): ByteArray

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): ByteArray

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): ByteArray

Call HEAD on a target API path.

headBytes

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

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

options

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

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, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call PATCH on a target API path.

patchBytes

suspend fun patchBytes(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, 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, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call POST on a target API path.

postBytes

suspend fun postBytes(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, 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, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null): ByteArray

Call PUT on a target API path.

putBytes

suspend fun putBytes(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, body: ByteArray? = null, 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): ByteArray?

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

tryDeleteBytes

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

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

tryGet

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

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

tryGetBytes

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

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

tryHead

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

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

tryHeadBytes

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

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

tryOptions

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

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

tryOptionsBytes

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

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

tryPatch

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

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

tryPatchBytes

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

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

tryPost

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

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

tryPostBytes

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

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

tryPut

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

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

tryPutBytes

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

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