kotlin-web/web.http

Package-level declarations

Types

Body

@SubclassOptInRequired(markerClass = [InternalApi::class])

interface Body

BodyInit

@SubclassOptInRequired(markerClass = [InternalApi::class])

interface BodyInit

Union of:

CrossOrigin

sealed interface CrossOrigin

FetchPriority

sealed interface FetchPriority

FetchResult

typealias FetchResult = Resource<Response>

Headers

open class Headers(init: ReadonlyArray<Tuple2<JsString, JsString>> = definedExternally) : MapLike.Mixin<JsString, JsString> , HeadersInit

The Headers interface of the Fetch API allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing headers from the list of the request's headers.

HeadersInit

@SubclassOptInRequired(markerClass = [InternalApi::class])

interface HeadersInit

ReferrerPolicy

sealed interface ReferrerPolicy

MDN Reference

Request

open class Request(val url: String, init: RequestInit = definedExternally) : Body, AbortableLike

The Request interface of the Fetch API represents a resource request.

RequestCache

sealed interface RequestCache

MDN Reference

RequestCredentials

sealed interface RequestCredentials

MDN Reference

RequestDestination

sealed interface RequestDestination

MDN Reference

RequestInit

interface RequestInit : Abortable

MDN Reference

RequestMethod

sealed interface RequestMethod

RequestMode

sealed interface RequestMode

MDN Reference

RequestPriority

sealed interface RequestPriority

MDN Reference

RequestRedirect

sealed interface RequestRedirect

MDN Reference

Response

open class Response(body: BodyInit? = definedExternally, init: ResponseInit = definedExternally) : Body

The Response interface of the Fetch API represents the response to a request.

ResponseInit

interface ResponseInit

MDN Reference

ResponseType

sealed interface ResponseType

MDN Reference

Properties

anonymous

val CrossOrigin.Companion.anonymous: CrossOrigin

audio

val RequestDestination.Companion.audio: RequestDestination

MDN Reference

audioworklet

val RequestDestination.Companion.audioworklet: RequestDestination

MDN Reference

auto

val FetchPriority.Companion.auto: FetchPriority

val RequestPriority.Companion.auto: RequestPriority

MDN Reference

basic

val ResponseType.Companion.basic: ResponseType

MDN Reference

cors

val RequestMode.Companion.cors: RequestMode

MDN Reference

val ResponseType.Companion.cors: ResponseType

MDN Reference

default

val RequestCache.Companion.default: RequestCache

MDN Reference

val ResponseType.Companion.default: ResponseType

MDN Reference

DELETE

val RequestMethod.Companion.DELETE: RequestMethod

document

val RequestDestination.Companion.document: RequestDestination

MDN Reference

embed

val RequestDestination.Companion.embed: RequestDestination

MDN Reference

error

val RequestRedirect.Companion.error: RequestRedirect

MDN Reference

val ResponseType.Companion.error: ResponseType

MDN Reference

val RequestRedirect.Companion.follow: RequestRedirect

MDN Reference

font

val RequestDestination.Companion.font: RequestDestination

MDN Reference

forceCache

val RequestCache.Companion.forceCache: RequestCache

MDN Reference

frame

val RequestDestination.Companion.frame: RequestDestination

MDN Reference

GET

val RequestMethod.Companion.GET: RequestMethod

HEAD

val RequestMethod.Companion.HEAD: RequestMethod

high

val FetchPriority.Companion.high: FetchPriority

val RequestPriority.Companion.high: RequestPriority

MDN Reference

iframe

val RequestDestination.Companion.iframe: RequestDestination

MDN Reference

image

val RequestDestination.Companion.image: RequestDestination

MDN Reference

include

val RequestCredentials.Companion.include: RequestCredentials

MDN Reference

json

val RequestDestination.Companion.json: RequestDestination

MDN Reference

low

val FetchPriority.Companion.low: FetchPriority

val RequestPriority.Companion.low: RequestPriority

MDN Reference

manifest

val RequestDestination.Companion.manifest: RequestDestination

MDN Reference

manual

val RequestRedirect.Companion.manual: RequestRedirect

MDN Reference

navigate

val RequestMode.Companion.navigate: RequestMode

MDN Reference

noCache

val RequestCache.Companion.noCache: RequestCache

MDN Reference

noCors

val RequestMode.Companion.noCors: RequestMode

MDN Reference

none

val ReferrerPolicy.Companion.none: ReferrerPolicy

MDN Reference

val RequestDestination.Companion.none: RequestDestination

MDN Reference

noReferrer

val ReferrerPolicy.Companion.noReferrer: ReferrerPolicy

MDN Reference

noReferrerWhenDowngrade

val ReferrerPolicy.Companion.noReferrerWhenDowngrade: ReferrerPolicy

MDN Reference

noStore

val RequestCache.Companion.noStore: RequestCache

MDN Reference

object

val RequestDestination.Companion.object: RequestDestination

MDN Reference

omit

val RequestCredentials.Companion.omit: RequestCredentials

MDN Reference

onlyIfCached

val RequestCache.Companion.onlyIfCached: RequestCache

MDN Reference

opaque

val ResponseType.Companion.opaque: ResponseType

MDN Reference

opaqueredirect

val ResponseType.Companion.opaqueredirect: ResponseType

MDN Reference

OPTIONS

val RequestMethod.Companion.OPTIONS: RequestMethod

origin

val ReferrerPolicy.Companion.origin: ReferrerPolicy

MDN Reference

originWhenCrossOrigin

val ReferrerPolicy.Companion.originWhenCrossOrigin: ReferrerPolicy

MDN Reference

paintworklet

val RequestDestination.Companion.paintworklet: RequestDestination

MDN Reference

PATCH

val RequestMethod.Companion.PATCH: RequestMethod

POST

val RequestMethod.Companion.POST: RequestMethod

PUT

val RequestMethod.Companion.PUT: RequestMethod

reload

val RequestCache.Companion.reload: RequestCache

MDN Reference

report

val RequestDestination.Companion.report: RequestDestination

MDN Reference

sameOrigin

val ReferrerPolicy.Companion.sameOrigin: ReferrerPolicy

MDN Reference

val RequestCredentials.Companion.sameOrigin: RequestCredentials

MDN Reference

val RequestMode.Companion.sameOrigin: RequestMode

MDN Reference

script

val RequestDestination.Companion.script: RequestDestination

MDN Reference

sharedworker

val RequestDestination.Companion.sharedworker: RequestDestination

MDN Reference

strictOrigin

val ReferrerPolicy.Companion.strictOrigin: ReferrerPolicy

MDN Reference

strictOriginWhenCrossOrigin

val ReferrerPolicy.Companion.strictOriginWhenCrossOrigin: ReferrerPolicy

MDN Reference

style

val RequestDestination.Companion.style: RequestDestination

MDN Reference

track

val RequestDestination.Companion.track: RequestDestination

MDN Reference

unsafeUrl

val ReferrerPolicy.Companion.unsafeUrl: ReferrerPolicy

MDN Reference

useCredentials

val CrossOrigin.Companion.useCredentials: CrossOrigin

video

val RequestDestination.Companion.video: RequestDestination

MDN Reference

worker

val RequestDestination.Companion.worker: RequestDestination

MDN Reference

xslt

val RequestDestination.Companion.xslt: RequestDestination

MDN Reference

Functions

arrayBuffer

inline suspend fun Body.arrayBuffer(): ArrayBuffer

The arrayBuffer() method of the Request interface reads the request body and returns it as a promise that resolves with an ArrayBuffer.

blob

inline suspend fun Body.blob(): Blob

The blob() method of the Request interface reads the request body and returns it as a promise that resolves with a Blob.

BodyInit

inline fun BodyInit(value: BufferSource): BodyInit

inline fun BodyInit(value: String): BodyInit

byteArray

suspend fun Body.byteArray(): ByteArray

bytes

inline suspend fun Body.bytes(): Uint8Array<ArrayBuffer>

The bytes() method of the Request interface reads the request body and returns it as a promise that resolves with a Uint8Array.

fetch

suspend fun fetch(url: String): FetchResult

suspend fun fetch(request: Request): FetchResult

suspend fun fetch(url: URLLike): FetchResult

suspend fun fetch(url: String, init: RequestInit): FetchResult

suspend fun fetch(request: Request, init: RequestInit): FetchResult

suspend fun fetch(url: URLLike, init: RequestInit): FetchResult

MDN Reference

fetchAsync

external fun fetchAsync(url: String, init: RequestInit? = definedExternally): Promise<Response>

external fun fetchAsync(request: Request, init: RequestInit? = definedExternally): Promise<Response>

external fun fetchAsync(url: URLLike, init: RequestInit? = definedExternally): Promise<Response>

MDN Reference

formData

inline suspend fun Body.formData(): FormData

The formData() method of the Request interface reads the request body and returns it as a promise that resolves with a FormData object.

HeadersInit

inline fun HeadersInit(value: ReadonlyArray<Tuple2<JsString, JsString>>): HeadersInit

inline fun HeadersInit(value: ReadonlyRecord<JsString, JsString>): HeadersInit

json

inline suspend fun Body.json(): JsAny?

The json() method of the Request interface reads the request body and returns it as a promise that resolves with the result of parsing the body text as JSON.

text

inline suspend fun Body.text(): String

The text() method of the Request interface reads the request body and returns it as a promise that resolves with a String. The response is always decoded using UTF-8.