Skip to content

Universal DevTools Kit SDK


Universal DevTools Kit SDK / @u-devtools/core / StorageApi

Interface: StorageApi ​

Defined in: index.ts:99

Storage API for plugin-specific persistent storage. Used for internal plugin state (e.g., last opened file, view preferences). Storage is isolated per plugin and persists across sessions.

Example ​

typescript
import type { StorageApi } from '@u-devtools/core';

function useStorage(api: StorageApi) {
  // Store values
  api.set('lastView', 'list');
  api.set('filters', { category: 'all', sort: 'name' });
  api.set('items', ['item1', 'item2', 'item3']);

  // Retrieve values with defaults
  const lastView = api.get('lastView', 'default');
  const filters = api.get('filters', { category: 'all' });
  const items = api.get<string[]>('items', []);

  // Remove values
  api.remove('lastView');
}

Methods ​

get() ​

get<T>(key, def): T

Defined in: index.ts:107

Get a stored value.

Type Parameters ​

Type ParameterDescription
TType of the stored value

Parameters ​

ParameterTypeDescription
keystringStorage key
defTDefault value if key doesn't exist

Returns ​

T

Stored value or default


remove() ​

remove(key): void

Defined in: index.ts:121

Remove a stored value.

Parameters ​

ParameterTypeDescription
keystringStorage key to remove

Returns ​

void


set() ​

set<T>(key, value): void

Defined in: index.ts:115

Set a stored value.

Type Parameters ​

Type ParameterDescription
TType of the value

Parameters ​

ParameterTypeDescription
keystringStorage key
valueTValue to store

Returns ​

void

Released under the MIT License.