WebStorageAPI

Types

storage

This Web Storage API interface provides access to a particular domain's session or local storage. It allows, for example, the addition, modification, or deletion of stored data items. See Storage on MDN

type storage = {length: int}

Record fields

length

int

Returns the number of key/value pairs. Read more on MDN

Module

There are methods and helpers defined in Storage .

storageEvent

A StorageEvent is sent to a window when a storage area it has access to is changed within the context of another document. See StorageEvent on MDN

type storageEvent = {
  type_: WebAPI.EventAPI.eventType,
  target: Null.t<WebAPI.EventAPI.eventTarget>,
  currentTarget: Null.t<WebAPI.EventAPI.eventTarget>,
  eventPhase: int,
  bubbles: bool,
  cancelable: bool,
  defaultPrevented: bool,
  composed: bool,
  isTrusted: bool,
  timeStamp: float,
  key: Null.t<string>,
  oldValue: Null.t<string>,
  newValue: Null.t<string>,
  url: string,
  storageArea: Null.t<storage>,
}

Record fields

type_

WebAPI.EventAPI.eventType

Returns the type of event, e.g. "click", "hashchange", or "submit". Read more on MDN

target

Null.t< WebAPI.EventAPI.eventTarget >

Returns the object to which event is dispatched (its target). Read more on MDN

currentTarget

Null.t< WebAPI.EventAPI.eventTarget >

Returns the object whose event listener's callback is currently being invoked. Read more on MDN

eventPhase

int

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. Read more on MDN

bubbles

bool

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise. Read more on MDN

cancelable

bool

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method. Read more on MDN

defaultPrevented

bool

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. Read more on MDN

composed

bool

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise. Read more on MDN

isTrusted

bool

Returns true if event was dispatched by the user agent, and false otherwise. Read more on MDN

timeStamp

float

Returns the event's timestamp as the number of milliseconds measured relative to the time origin. Read more on MDN

key

Null.t< string >

Returns the key of the storage item being changed. Read more on MDN

oldValue

Null.t< string >

Returns the old value of the key of the storage item whose value is being changed. Read more on MDN

newValue

Null.t< string >

Returns the new value of the key of the storage item whose value is being changed. Read more on MDN

url

string

Returns the URL of the document whose storage item changed. Read more on MDN

storageArea

Null.t< storage >

Returns the Storage object that was affected. Read more on MDN

Module

There are methods and helpers defined in StorageEvent .

storageEventInit

type storageEventInit = {
  mutable bubbles?: bool,
  mutable cancelable?: bool,
  mutable composed?: bool,
  mutable key?: Null.t<string>,
  mutable oldValue?: Null.t<string>,
  mutable newValue?: Null.t<string>,
  mutable url?: string,
  mutable storageArea?: Null.t<storage>,
}

Record fields

bubbles

option< bool >

cancelable

option< bool >

composed

option< bool >

key

option< Null.t< string > >

oldValue

option< Null.t< string > >

newValue

option< Null.t< string > >

url

option< string >

storageArea

option< Null.t< storage > >