kotlin-web/web.http/Headers

Headers

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

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.

MDN Reference

Constructors

Headers

constructor(init: ReadonlyArray<Tuple2<JsString, JsString>> = definedExternally)

constructor(init: ReadonlyRecord<JsString, JsString>)

constructor(init: Headers)

Functions

append

fun append(name: String, value: String)

The append() method of the Headers interface appends a new value onto an existing header inside a Headers object, or adds the header if it does not already exist.

delete

fun delete(name: String)

The delete() method of the Headers interface deletes a header from the current Headers object.

entries

open override fun entries(): JsIterator<Tuple2<JsString, JsString>>

forEach

open override fun forEach(action: (value: JsString, key: JsString) -> Unit)

get

open operator fun get(key: Symbol.iterator): () -> JsIterator<Tuple2<JsString, JsString>>

fun get(name: String): String?

The get() method of the Headers interface returns a byte string of all the values of a header within a Headers object with a given name. If the requested header doesn't exist in the Headers object, it returns null.

getSetCookie

fun getSetCookie(): ReadonlyArray<JsString>

The getSetCookie() method of the Headers interface returns an array containing the values of all Set-Cookie headers associated with a response. This allows Headers objects to handle having multiple Set-Cookie headers, which wasn't possible prior to its implementation.

has

fun has(name: String): Boolean

The has() method of the Headers interface returns a boolean stating whether a Headers object contains a certain header.

keys

open override fun keys(): JsIterator<JsString>

set

fun set(name: String, value: String)

The set() method of the Headers interface sets a new value for an existing header inside a Headers object, or adds the header if it does not already exist.

values

open override fun values(): JsIterator<JsString>