Storage
Store data locally within the browser. Manage session storage and local storage.
interface 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.
Index Signatures
Properties
length: number Returns the number of key/value pairs currently present in the list associated with the object.
Methods
clear(): void Empties the list associated with the object of all key/value pairs, if there are any.
getItem(key: string): string | null Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
key(index: number): string | null Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
removeItem(key: string): void Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
setItem(
key: string,
value: string,
): void 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.)
variable Storage
This Web Storage API interface provides access to a particular domain's session or local storage. Instances of this interface are not constructable and are accessed through the localStorage and sessionStorage globals.
Properties
See
variable localStorage
Deno's localStorage API provides a way to store key-value pairs in a web-like environment, similar to the Web Storage API found in browsers. It allows developers to persist data across sessions in a Deno application. This API is particularly useful for applications that require a simple and effective way to store data locally.
- Key-Value Storage: Stores data as key-value pairs.
- Persistent: Data is retained even after the application is closed.
- Synchronous API: Operations are performed synchronously.
localStorage is similar to sessionStorage, and shares the same API methods, visible in the Storage type.
When using the --location flag, the origin for the location is used to uniquely store the data. That means a location of http://example.com/a.ts and http://example.com/b.ts and http://example.com:80/ would all share the same storage, but https://example.com/ would be different.
For more information, see the reference guide for Web Storage and using the --location flag.
Examples
// Set a value in localStorage
localStorage.setItem("key", "value");
// Get a value from localStorage
const value = localStorage.getItem("key");
console.log(value); // Output: "value"
// Remove a value from localStorage
localStorage.removeItem("key");
// Clear all values from localStorage
localStorage.clear();
Type
See
variable sessionStorage
Deno's sessionStorage API operates similarly to the localStorage API, but it is intended for storing data temporarily for the duration of a session. Data stored in sessionStorage is cleared when the application session or process ends. This makes it suitable for temporary data that you do not need to persist across user sessions.
- Key-Value Storage: Stores data as key-value pairs.
- Session-Based: Data is only available for the duration of the page session.
- Synchronous API: Operations are performed synchronously.
sessionStorage is similar to localStorage, and shares the same API methods, visible in the Storage type.
For more information, see the reference guide for Web Storage
Examples
// Set a value in sessionStorage
sessionStorage.setItem("key", "value");
// Get a value from sessionStorage
const value = sessionStorage.getItem("key");
console.log(value); // Output: "value"
// Remove a value from sessionStorage
sessionStorage.removeItem("key");
// Clear all the values from sessionStorage
sessionStorage.clear();
Type
See
© 2018–2025 the Deno authors
Licensed under the MIT License.
https://docs.deno.com/api/web/storage