Function: initStorage()

function initStorage<T>(
   ctx: Context, 
   name: string, 
   scope: "user" | "org" | "skill"): {
  name: string;
  path: string;
  get: <K>(key: K) => Promise<T[K]>;
  getAll: () => Promise<T>;
  set: <K>(key: K, val: T[K]) => Promise<void>;
  setAll: (val: T) => Promise<void>;
  update: <K>(key: K, callback: (data: T[K]) => Promise<T[K]>) => Promise<void>;
  updateAll: (callback: (data: T) => Promise<T>) => Promise<void>;
  remove: <K>(key: K) => Promise<void>;
  removeAll: () => Promise<void>;
};

Defined in: src/storage/index.ts:227

Initialize a storage instance for a given context, name, and scope.

Type Parameters

Type Parameter	Description
T extends Record<string, any>	Shape of the data to store.

Parameters

Parameter	Type	Description
ctx	Context	Context for the storage instance.
name	string	Name for the storage file.
scope	"user" | "org" | "skill"	Storage scope: 'user', 'org', or 'skill'.

Returns

A storage object with get, set, update, and remove methods.

name

name: string;

path

path: string = storePath;

get()

get: <K>(key: K) => Promise<T[K]>;

Get a value from storage.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
key	K	Key to retrieve.

Returns

Promise<T[K]>

The stored value.

Example

const roast = await store.get('roast');

getAll()

getAll: () => Promise<T>;

Get all values from storage.

Returns

Promise<T>

All stored data.

Example

const allPrefs = await store.getAll();

set()

set: <K>(key: K, val: T[K]) => Promise<void>;

Set a value in storage.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
key	K	Key to write.
val	T[K]	Value to store.

Returns

Promise<void>

Resolves when the write completes.

Example

await store.set('roast', 'espresso');

setAll()

setAll: (val: T) => Promise<void>;

Set all values in storage at once.

Parameters

Parameter	Type	Description
val	T	Complete data object to store.

Returns

Promise<void>

Resolves when the write completes.

Example

await store.setAll({roast: 'dark', shots: 3});

update()

update: <K>(key: K, callback: (data: T[K]) => Promise<T[K]>) => Promise<void>;

Update a value in storage using a callback.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
key	K	Key to update.
callback	(data: T[K]) => Promise<T[K]>	Receive the current value, return the new value.

Returns

Promise<void>

Resolves when the update completes.

Example

await store.update('shots', async (prev) => prev + 1);

updateAll()

updateAll: (callback: (data: T) => Promise<T>) => Promise<void>;

Update all values in storage using a callback.

Parameters

Parameter	Type	Description
callback	(data: T) => Promise<T>	Receive all current data, return the new data.

Returns

Promise<void>

Resolves when the update completes.

Example

await store.updateAll(async (data) => ({...data, shots: 4}));

remove()

remove: <K>(key: K) => Promise<void>;

Remove a key and its value from storage.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
key	K	Key to remove.

Returns

Promise<void>

Example

await store.remove('roast');

removeAll()

removeAll: () => Promise<void>;

Remove all data from storage.

Returns

Promise<void>

Example

await store.removeAll();

Example

interface PizzaPrefs { topping: string; crustSize: number }
const store = initStorage<PizzaPrefs>(ctx, 'pizzaPrefs', 'user');
await store.set('topping', 'pineapple');
const topping = await store.get('topping'); // 'pineapple'