---
title: "CookieStore | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Interface 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](https://developer.mozilla.org/docs/Web/API/CookieStore)

interface CookieStore {  
    [onchange](#onchange): ((this: CookieStore, ev: [CookieChangeEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieChangeEvent/)) \=> any) | null;  
    [addEventListener](#addeventlistener-1)<[K](#addeventlistenerk) extends "change"\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: CookieStore, ev: [CookieStoreEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [addEventListener](#addeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [delete](#delete-1)(name: string): Promise<void\>;  
    [delete](#delete-2)(options: [CookieStoreDeleteOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreDeleteOptions/)): Promise<void\>;  
    [dispatchEvent](#dispatchevent-1)(event: Event): boolean;  
    [get](#get-1)(name: string): Promise<[CookieListItem](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieListItem/) | null\>;  
    [get](#get-2)(options?: [CookieStoreGetOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreGetOptions/)): Promise<[CookieListItem](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieListItem/) | null\>;  
    [getAll](#getall-1)(name: string): Promise<[CookieList](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.CookieList/)\>;  
    [getAll](#getall-2)(options?: [CookieStoreGetOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreGetOptions/)): Promise<[CookieList](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.CookieList/)\>;  
    [removeEventListener](#removeeventlistener-1)<[K](#removeeventlistenerk) extends "change"\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: CookieStore, ev: [CookieStoreEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void;  
    [removeEventListener](#removeeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void;  
    [set](#set-1)(name: string, value: string): Promise<void\>;  
    [set](#set-2)(options: [CookieInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieInit/)): Promise<void\>;  
}

#### Hierarchy

-   EventTarget
    -   CookieStore

##### Index

### Properties[](#properties)

[onchange](#onchange)

### Methods[](#methods)

[addEventListener](#addeventlistener) [delete](#delete) [dispatchEvent](#dispatchevent) [get](#get) [getAll](#getall) [removeEventListener](#removeeventlistener) [set](#set)

## Properties[](#properties-1)

### onchange[](#onchange)

onchange: ((this: CookieStore, ev: [CookieChangeEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieChangeEvent/)) \=> any) | null

[MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/change_event)

## Methods[](#methods-1)

### addEventListener[](#addeventlistener)

-   addEventListener<[K](#addeventlistenerk) extends "change"\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: CookieStore, ev: [CookieStoreEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-1)
    
    The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Type Parameters
    
    -   K extends "change"
    
    #### Parameters
    
    -   type: [K](#addeventlistenerk)
    -   listener: (this: CookieStore, ev: [CookieStoreEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreEventMap/)\[[K](#addeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    
-   addEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-2)
    
    The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    

### delete[](#delete)

-   delete(name: string): Promise<void\>[](#delete-1)
    
    The **`delete()`** method of the CookieStore interface deletes a cookie that matches the given name or options object. The method expires the cookie by changing its date to one in the past.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/delete)
    
    #### Parameters
    
    -   name: string
    
    #### Returns Promise<void\>
    
-   delete(options: [CookieStoreDeleteOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreDeleteOptions/)): Promise<void\>[](#delete-2)
    
    #### Parameters
    
    -   options: [CookieStoreDeleteOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreDeleteOptions/)
    
    #### Returns Promise<void\>
    

### dispatchEvent[](#dispatchevent)

-   dispatchEvent(event: Event): boolean[](#dispatchevent-1)
    
    The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
    
    #### Parameters
    
    -   event: Event
    
    #### Returns boolean
    
    Inherited from EventTarget.dispatchEvent
    

### get[](#get)

-   get(name: string): Promise<[CookieListItem](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieListItem/) | null\>[](#get-1)
    
    The **`get()`** method of the CookieStore interface returns a Promise that resolves to a single cookie matching the given name or options object. The method will return the first cookie that matches.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/get)
    
    #### Parameters
    
    -   name: string
    
    #### Returns Promise<[CookieListItem](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieListItem/) | null\>
    
-   get(options?: [CookieStoreGetOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreGetOptions/)): Promise<[CookieListItem](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieListItem/) | null\>[](#get-2)
    
    #### Parameters
    
    -   `Optional`options: [CookieStoreGetOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreGetOptions/)
    
    #### Returns Promise<[CookieListItem](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieListItem/) | null\>
    

### getAll[](#getall)

-   getAll(name: string): Promise<[CookieList](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.CookieList/)\>[](#getall-1)
    
    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. Passing no parameters will return all cookies for the current context.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/getAll)
    
    #### Parameters
    
    -   name: string
    
    #### Returns Promise<[CookieList](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.CookieList/)\>
    
-   getAll(options?: [CookieStoreGetOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreGetOptions/)): Promise<[CookieList](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.CookieList/)\>[](#getall-2)
    
    #### Parameters
    
    -   `Optional`options: [CookieStoreGetOptions](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreGetOptions/)
    
    #### Returns Promise<[CookieList](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.CookieList/)\>
    

### removeEventListener[](#removeeventlistener)

-   removeEventListener<[K](#removeeventlistenerk) extends "change"\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: CookieStore, ev: [CookieStoreEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-1)
    
    The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Type Parameters
    
    -   K extends "change"
    
    #### Parameters
    
    -   type: [K](#removeeventlistenerk)
    -   listener: (this: CookieStore, ev: [CookieStoreEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieStoreEventMap/)\[[K](#removeeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener
    
-   removeEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-2)
    
    The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener
    

### set[](#set)

-   set(name: string, value: string): Promise<void\>[](#set-1)
    
    The **`set()`** method of the CookieStore interface sets a cookie with the given name and value or options object.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/set)
    
    #### Parameters
    
    -   name: string
    -   value: string
    
    #### Returns Promise<void\>
    
-   set(options: [CookieInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieInit/)): Promise<void\>[](#set-2)
    
    #### Parameters
    
    -   options: [CookieInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.CookieInit/)
    
    #### Returns Promise<void\>