Storage

Search…
Storage
The storage APIs can be used to store non-sensitive data that is persisted across command launches.
All commands in an extension have shared access to the stored data. Extensions can not access the storage of other extensions.
Values can be managed through functions such as LocalStorage.getItem, LocalStorage.setItem, or LocalStorage.removeItem. A typical use case is storing user-related data, for example entered todos.
The API is not meant to store large amounts of data. For this, use Node's built-in APIs to write files, e.g. to the extension's support directory.
API Reference
LocalStorage.getItem
Retrieve the stored value for the given key.
Signature
async function getItem(key: string): Promise<Value | undefined>;
Example
import { LocalStorage } from "@raycast/api";
​
export default async () => {
  const item = await LocalStorage.getItem<string>("favorite-fruit");
  console.log(item);
};
Parameters
Name
Description
Type
key*
The key you want to retrieve the value of.
string
Return
A Promise that resolves with the stored value for the given key. If the key does not exist, undefined is returned.
LocalStorage.setItem
Stores a value for the given key.
Signature
async function setItem(key: string, value: Value): Promise<void>;
Example
import { LocalStorage } from "@raycast/api";
​
export default async () => {
  await LocalStorage.setItem("favorite-fruit", "cherry");
};
Parameters
Name
Description
Type
key*
The key you want to create or update the value of.
string
value*
The value you want to create or update for the given key.
​LocalStorage.Value​
Return
A Promise that resolves when the value is stored.
LocalStorage.removeItem
Removes the stored value for the given key.
Signature
async function removeItem(key: string): Promise<void>;
Example
import { LocalStorage } from "@raycast/api";
​
export default async () => {
  await LocalStorage.removeItem("favorite-fruit");
};
Parameters
Name
Description
Type
key*
The key you want to remove the value of.
string
Return
A Promise that resolves when the value is removed.
LocalStorage.allItems
Retrieve all stored values in the local storage of an extension.
Signature
async function allItems(): Promise<Values>;
Example
import { LocalStorage } from "@raycast/api";
​
interface Values {
  todo: string;
  priority: number;
}
​
export default async () => {
  const items = await LocalStorage.allItems<Values>();
  console.log(`Local storage item count: ${Object.entries(items).length}`);
};
Return
A Promise that resolves with an object containing all Values.
LocalStorage.clear
Removes all stored values of an extension.
Signature
async function clear(): Promise<void>;
Example
import { LocalStorage } from "@raycast/api";
​
export default async () => {
  await LocalStorage.clear();
};
Return
A Promise that resolves when all values are removed.
Types
LocalStorage.Values
Values of local storage items.
For type-safe values, you can define your own interface. Use the keys of the local storage items as the property names.
Properties
Name
Type
Description
[key: string]
any
The local storage value of a given key.
LocalStorage.Value
Value: string | number | boolean;
Supported storage value types.
Example
import { LocalStorage } from "@raycast/api";
​
export default async () => {
  // String
  await LocalStorage.setItem("favorite-fruit", "cherry");
​
  // Number
  await LocalStorage.setItem("fruit-basket-count", 3);
​
  // Boolean
  await LocalStorage.setItem("fruit-eaten-today", true);
};
API Reference - Previous
Preferences
Next - API Reference
System Utilities
Last modified 2mo ago
Copy link
Edit on GitHub
Outline
API Reference
LocalStorage.getItem
LocalStorage.setItem
LocalStorage.removeItem
LocalStorage.allItems