Class StorageBag

Hierarchy

StorageBag

Implements

IStorageBag

Index

Constructors

constructor

Properties

provider

Methods

Constructors

constructor

new StorageBag(provider: IStorageProvider): StorageBag

- Defined in packadic/lib/Storage.ts:47
Parameters
- provider: IStorageProvider
Returns StorageBag

Properties

provider

provider: IStorageProvider

Methods

clear

clear(): void

Implementation of IStorageBag.clear
- Defined in packadic/lib/Storage.ts:145
Clear the storage, will clean all saved items

Returns void

del

del(key: any): void

Implementation of IStorageBag.del
- Defined in packadic/lib/Storage.ts:138
Delete a value from the storage

Parameters
- key: any
Returns void

get

get(key: any, options?: any): any

Implementation of IStorageBag.get
- Defined in packadic/lib/Storage.ts:103
Get a value from the storage

Parameters
- key: any
- Optional options: any
Returns any

getSize

getSize(key: any): string

Implementation of IStorageBag.getSize
- Defined in packadic/lib/Storage.ts:156
Get total localstorage size in MB. If key is provided, it will return size in MB only for the corresponding item.

Parameters
- key: any
Returns string

on

on(callback: Function): void

- Defined in packadic/lib/Storage.ts:57
Add a event listener for the 'onstorage' event

Parameters
- callback: Function
Returns void

set

set(key: any, val: any, options?: any): void

Implementation of IStorageBag.set
- Defined in packadic/lib/Storage.ts:79
Save a value to the storage

Parameters
- key: any
  
  The unique id to save the data on
- val: any
  
  The value, can be any datatype. If it's an object, make sure to enable json in the options
- Optional options: any
Returns void