Class LocalStorage<T>

A wrapper around the conf package that provides a strongly-typed interface for accessing the local storage.

Type Parameters

T extends Record<string, any>

Index

Constructors

Methods

clear delete get set

Constructors

constructor

new LocalStorage<T extends Record<string, any>>(
options: { cwd?: string; projectName?: string },
): LocalStorage<T>
Type Parameters
- T extends Record<string, any>
Parameters
- options: { cwd?: string; projectName?: string }
Returns LocalStorage<T>
- Defined in packages/cli-kit/src/public/node/local-storage.ts:15

Methods

clear

clear(): void
Clear the local storage (delete all values).

Returns void
Throws
AbortError if a permission error occurs.

Throws
BugError if an unexpected error occurs.
- Defined in packages/cli-kit/src/public/node/local-storage.ts:75

delete

delete<TKey extends string | number | symbol>(key: TKey): void
Delete a value from the local storage.
Type Parameters
- TKey extends string | number | symbol
Parameters
- key: TKey
  The key to delete.
Returns void
Throws
AbortError if a permission error occurs.

Throws
BugError if an unexpected error occurs.
- Defined in packages/cli-kit/src/public/node/local-storage.ts:60

get

get<TKey extends string | number | symbol>(key: TKey): T[TKey] | undefined
Get a value from the local storage.
Type Parameters
- TKey extends string | number | symbol
Parameters
- key: TKey
  The key to get.
Returns T[TKey] | undefined
The value.

Throws
AbortError if a permission error occurs.

Throws
BugError if an unexpected error occurs.
- Defined in packages/cli-kit/src/public/node/local-storage.ts:27

set

set<TKey extends string | number | symbol>(key: TKey, value?: T[TKey]): void
Set a value in the local storage.
Type Parameters
- TKey extends string | number | symbol
Parameters
- key: TKey
  The key to set.
- Optionalvalue: T[TKey]
  The value to set.
Returns void
Throws
AbortError if a permission error occurs.

Throws
BugError if an unexpected error occurs.
- Defined in packages/cli-kit/src/public/node/local-storage.ts:44