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

Headers

open class Headers(init: ReadonlyArray<Tuple2<ERROR CLASS: Symbol not found for JsString, ERROR CLASS: Symbol not found for JsString>> = definedExternally) : MapLike<ERROR CLASS: Symbol not found for JsString, ERROR CLASS: Symbol not found for 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

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

RequestCredentials

sealed interface RequestCredentials

RequestDestination

sealed interface RequestDestination

RequestInit

interface RequestInit : Abortable

RequestMethod

sealed interface RequestMethod

RequestMode

sealed interface RequestMode

RequestPriority

sealed interface RequestPriority

RequestRedirect

sealed interface RequestRedirect

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

ResponseType

sealed interface ResponseType

Properties

anonymous

val CrossOrigin.Companion.anonymous: CrossOrigin

audio

val RequestDestination.Companion.audio: RequestDestination

audioworklet

val RequestDestination.Companion.audioworklet: RequestDestination

auto

val FetchPriority.Companion.auto: FetchPriority

val RequestPriority.Companion.auto: RequestPriority

basic

val ResponseType.Companion.basic: ResponseType

cors

val RequestMode.Companion.cors: RequestMode

val ResponseType.Companion.cors: ResponseType

default

val RequestCache.Companion.default: RequestCache

val ResponseType.Companion.default: ResponseType

DELETE

val RequestMethod.Companion.DELETE: RequestMethod

document

val RequestDestination.Companion.document: RequestDestination

embed

val RequestDestination.Companion.embed: RequestDestination

error

val RequestRedirect.Companion.error: RequestRedirect

val ResponseType.Companion.error: ResponseType

val RequestRedirect.Companion.follow: RequestRedirect

font

val RequestDestination.Companion.font: RequestDestination

forceCache

val RequestCache.Companion.forceCache: RequestCache

frame

val RequestDestination.Companion.frame: RequestDestination

GET

val RequestMethod.Companion.GET: RequestMethod

HEAD

val RequestMethod.Companion.HEAD: RequestMethod

high

val FetchPriority.Companion.high: FetchPriority

val RequestPriority.Companion.high: RequestPriority

iframe

val RequestDestination.Companion.iframe: RequestDestination

image

val RequestDestination.Companion.image: RequestDestination

include

val RequestCredentials.Companion.include: RequestCredentials

json

val RequestDestination.Companion.json: RequestDestination

low

val FetchPriority.Companion.low: FetchPriority

val RequestPriority.Companion.low: RequestPriority

manifest

val RequestDestination.Companion.manifest: RequestDestination

manual

val RequestRedirect.Companion.manual: RequestRedirect

navigate

val RequestMode.Companion.navigate: RequestMode

noCache

val RequestCache.Companion.noCache: RequestCache

noCors

val RequestMode.Companion.noCors: RequestMode

none

val CrossOrigin.Companion.none: CrossOrigin

val ReferrerPolicy.Companion.none: ReferrerPolicy

val RequestDestination.Companion.none: RequestDestination

noReferrer

val ReferrerPolicy.Companion.noReferrer: ReferrerPolicy

noReferrerWhenDowngrade

val ReferrerPolicy.Companion.noReferrerWhenDowngrade: ReferrerPolicy

noStore

val RequestCache.Companion.noStore: RequestCache

object

val RequestDestination.Companion.object: RequestDestination

omit

val RequestCredentials.Companion.omit: RequestCredentials

onlyIfCached

val RequestCache.Companion.onlyIfCached: RequestCache

opaque

val ResponseType.Companion.opaque: ResponseType

opaqueredirect

val ResponseType.Companion.opaqueredirect: ResponseType

OPTIONS

val RequestMethod.Companion.OPTIONS: RequestMethod

origin

val ReferrerPolicy.Companion.origin: ReferrerPolicy

originWhenCrossOrigin

val ReferrerPolicy.Companion.originWhenCrossOrigin: ReferrerPolicy

paintworklet

val RequestDestination.Companion.paintworklet: RequestDestination

PATCH

val RequestMethod.Companion.PATCH: RequestMethod

POST

val RequestMethod.Companion.POST: RequestMethod

PUT

val RequestMethod.Companion.PUT: RequestMethod

reload

val RequestCache.Companion.reload: RequestCache

report

val RequestDestination.Companion.report: RequestDestination

sameOrigin

val ReferrerPolicy.Companion.sameOrigin: ReferrerPolicy

val RequestCredentials.Companion.sameOrigin: RequestCredentials

val RequestMode.Companion.sameOrigin: RequestMode

script

val RequestDestination.Companion.script: RequestDestination

sharedworker

val RequestDestination.Companion.sharedworker: RequestDestination

strictOrigin

val ReferrerPolicy.Companion.strictOrigin: ReferrerPolicy

strictOriginWhenCrossOrigin

val ReferrerPolicy.Companion.strictOriginWhenCrossOrigin: ReferrerPolicy

style

val RequestDestination.Companion.style: RequestDestination

track

val RequestDestination.Companion.track: RequestDestination

unsafeUrl

val ReferrerPolicy.Companion.unsafeUrl: ReferrerPolicy

useCredentials

val CrossOrigin.Companion.useCredentials: CrossOrigin

video

val RequestDestination.Companion.video: RequestDestination

worker

val RequestDestination.Companion.worker: RequestDestination

xslt

val RequestDestination.Companion.xslt: RequestDestination

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

suspend fun fetch(request: Request): Response

suspend fun fetch(url: URL): Response

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

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

suspend fun fetch(url: URL, init: RequestInit): Response

MDN Reference

fetchAsync

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

MDN Reference

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

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

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<ERROR CLASS: Symbol not found for JsString, ERROR CLASS: Symbol not found for JsString>>): HeadersInit

inline fun HeadersInit(value: ReadonlyRecord<ERROR CLASS: Symbol not found for JsString, ERROR CLASS: Symbol not found for JsString>): HeadersInit

json

inline suspend fun Body.json(): ERROR CLASS: Symbol not found for 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.