Storage<TKey>
Defined in: packages/core/src/storage.ts:8
Type Parameters
| Type Parameter | Default type |
|---|---|
TKey extends string | string |
Implements
SimpleStorage
Constructors
Constructor
new Storage<TKey>(options): Storage<TKey>;
Defined in: packages/core/src/storage.ts:13
Parameters
| Parameter | Type |
|---|---|
options | StorageOptions |
Returns
Storage<TKey>
Properties
prefix
readonly prefix: string;
Defined in: packages/core/src/storage.ts:9
Methods
getItem()
getItem(key): string | null;
Defined in: packages/core/src/storage.ts:18
The getItem() method of the Storage interface, when passed a key name, will return that key's value, or null if the key does not exist, in the given Storage object.
Parameters
| Parameter | Type |
|---|---|
key | TKey |
Returns
string | null
Implementation of
SimpleStorage.getItem
join()
join<TKeyOverride>(path): Storage<TKeyOverride extends void ? TKey : TKeyOverride>;
Defined in: packages/core/src/storage.ts:30
Type Parameters
| Type Parameter | Default type |
|---|---|
TKeyOverride extends string | void | void |
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
Storage<TKeyOverride extends void ? TKey : TKeyOverride>
removeItem()
removeItem(key): void;
Defined in: packages/core/src/storage.ts:22
The removeItem() method of the Storage interface, when passed a key name, will remove that key from the given Storage object if it exists. The Storage interface of the Web Storage API provides access to a particular domain's session or local storage.
Parameters
| Parameter | Type |
|---|---|
key | TKey |
Returns
void
Implementation of
SimpleStorage.removeItem
setItem()
setItem(key, value): void;
Defined in: packages/core/src/storage.ts:26
The setItem() method of the Storage interface, when passed a key name and value, will add that key to the given Storage object, or update that key's value if it already exists.
Parameters
| Parameter | Type |
|---|---|
key | TKey |
value | string |
Returns
void
Implementation of
SimpleStorage.setItem