Interface IStorage<T>

A type-hinted Storage interface.

interface IStorage<T> {
    length: number;
    totalSize: number;
    clear(): void;
    estimateSize(key, value): number;
    getItem(key): T;
    key(index): string;
    removeItem(key): void;
    setItem(key, value): void;
    size(key?): number;
}

Type Parameters

T

Hierarchy (view full)

IStorage
- IPerishableStorage

Implemented by

BrowserStorage

Index

Properties

length totalSize

Methods

clear estimateSize getItem key removeItem setItem size

Properties

length

length: number

The number of items in storage.

totalSize

totalSize: number

The total possible size of storage in bytes.

Methods

clear

clear(): void
Clear all items from storage.

Returns void
- Defined in src/core/interfaces/storage.ts:40

estimateSize

estimateSize(key, value): number
Calculate how much space an item would take up in storage.
Parameters
- key: string
- value: T
Returns number
- Defined in src/core/interfaces/storage.ts:46

getItem

getItem(key): T
Get an item from storage.
Parameters
- key: string
Returns T
- Defined in src/core/interfaces/storage.ts:31

key

key(index): string
Get the key at the given index.
Parameters
- index: number
Returns string
- Defined in src/core/interfaces/storage.ts:28

removeItem

removeItem(key): void
Remove an item from storage.
Parameters
- key: string
Returns void
- Defined in src/core/interfaces/storage.ts:37

setItem

setItem(key, value): void
Set an item in storage.
Parameters
- key: string
- value: T
Returns void
- Defined in src/core/interfaces/storage.ts:34

size

size(key?): number
Calculate how many bytes of storage are in use. If no key is given, calculate for all keys.
Parameters
- Optional key: string
Returns number
- Defined in src/core/interfaces/storage.ts:43