CookieStore

The CookieStore interface of the Cookie Store API provides methods for getting and setting cookies asynchronously from either a page or a service worker. Available only in secure contexts.

MDN Reference

Properties

changeEvent

val changeEvent: EventInstance<CookieChangeEvent, CookieStore, CookieStore>

MDN Reference

onchange

var onchange: EventHandler<CookieChangeEvent, CookieStore, CookieStore>?

MDN Reference

Functions

delete

suspend fun delete(name: String)

The delete() method of the CookieStore interface deletes a cookie that matches the given name or options object.

suspend fun delete(options: CookieStoreDeleteOptions)

deleteAsync

fun deleteAsync(name: String): Promise<Void>

fun deleteAsync(options: CookieStoreDeleteOptions): Promise<Void>

dispatchEvent

fun dispatchEvent(event: Event): Boolean

get

suspend fun get(name: String): CookieListItem?

The get() method of the CookieStore interface returns a Promise that resolves to a single cookie matching the given name or options object.

suspend fun get(options: CookieStoreGetOptions = definedExternally): CookieListItem?

getAll

suspend fun getAll(name: String): CookieList

The getAll() method of the CookieStore interface returns a Promise that resolves as an array of cookies that match the name or options passed to it.

suspend fun getAll(options: CookieStoreGetOptions = definedExternally): CookieList

getAllAsync

fun getAllAsync(name: String): Promise<CookieList>

fun getAllAsync(options: CookieStoreGetOptions = definedExternally): Promise<CookieList>

getAsync

fun getAsync(name: String): Promise<CookieListItem?>

fun getAsync(options: CookieStoreGetOptions = definedExternally): Promise<CookieListItem?>

set

suspend fun set(options: CookieInit)

suspend fun set(name: String, value: String)

The set() method of the CookieStore interface sets a cookie with the given name and value or options object.

setAsync

fun setAsync(options: CookieInit): Promise<Void>

fun setAsync(name: String, value: String): Promise<Void>

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>