browser-ext/com.varabyte.kobweb.browser.http/HttpFetcher

HttpFetcher

class HttpFetcher(window: Window)(source)

A class with a slightly friendlier API than using Window.fetch directly by providing HTTP method helper methods.

For example:

// Without HttpFetcher
window.fetch(HttpMethod.GET, "/some/api/path")

// With HttpFetcher
window.http.get("/some/api/path")
// ... or a version that won't throw exceptions
// window.http.tryGet("/some/api/path")

The class additionally exposes a logOnError field which globally applies to all try... methods.

Constructors

HttpFetcher

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

Call DELETE on a target resource.

get

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

Call GET on a target resource.

head

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

Call HEAD on a target resource.

options

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

Call OPTIONS on a target resource.

patch

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

Call PATCH on a target resource.

post

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

Call POST on a target resource.

put

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

Call PUT on a target resource.

tryDelete

suspend fun tryDelete(resource: 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(resource: 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(resource: 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(resource: 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(resource: 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(resource: 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(resource: 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.