Storage

Values

clear

Removes all key/value pairs, if there are any.

Dispatches a storage event on Window objects holding an equivalent WebApiStorage object. Read more on MDN

let clear: WebStorageTypes.storage => unit

Parameters

WebStorageTypes.storage

Return type

unit

getItem

Returns the current value associated with the given key, or null if the given key does not exist. Read more on MDN

let getItem: (WebStorageTypes.storage, string) => Null.t<string>

Parameters

WebStorageTypes.storage string

Return type

Stdlib.Null.t< string >

key

Returns the name of the nth key, or null if n is greater than or equal to the number of key/value pairs. Read more on MDN

let key: (WebStorageTypes.storage, int) => Null.t<string>

Parameters

WebStorageTypes.storage int

Return type

Stdlib.Null.t< string >

removeItem

Removes the key/value pair with the given key, if a key/value pair with the given key exists.

Dispatches a storage event on Window objects holding an equivalent WebApiStorage object. Read more on MDN

let removeItem: (WebStorageTypes.storage, string) => unit

Parameters

WebStorageTypes.storage string

Return type

unit

setItem

Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.

Throws a "QuotaExceededError" DOMException exception if the new value couldn't be set. (Setting could fail if, e.g., the user has disabled storage for the site, or if the quota has been exceeded.)

Dispatches a storage event on Window objects holding an equivalent WebApiStorage object. Read more on MDN

let setItem: (
  WebStorageTypes.storage,
  ~key: string,
  ~value: string,
) => unit

Parameters

WebStorageTypes.storage string string

Return type

unit