goog.storage.RichStorage

Provided By	`goog.storage.RichStorage`
Extends	`goog.storage.Storage`
All Known Direct Subclasses	`goog.storage.ExpiringStorage`

Provides a storage for data with attached metadata.

new RichStorage( `mechanism` )

Parameters

`mechanism`	`goog.storage.mechanism.Mechanism`
	The underlying storage mechanism.

VIEW SOURCE

Instance Methods

Gets an item from the data storage.

Overrides

goog.storage.Storage

Parameters

`key`	`string`
	The key to get.

Returns

*

Deserialized value or undefined if not found.

VIEW SOURCE

Get an item wrapper (the item and its metadata) from the storage.

WARNING: This returns an Object, which once used to be goog.storage.RichStorage.Wrapper. This is due to the fact that deserialized objects lose type information and it is hard to do proper typecasting in JavaScript. Be sure you know what you are doing when using the returned value.

Parameters

`key`	`string`
	The key to get.

Returns

(Object|undefined)

The wrapper, or undefined if not found.

VIEW SOURCE

Removes an item from the data storage.

Defined by

goog.storage.Storage

Parameters

`key`	`string`
	The key to remove.

VIEW SOURCE

Sets an item in the data storage.

Overrides

goog.storage.Storage

Parameters

`key`	`string`
	The key to set.
`value`	`*`
	The value to serialize to a string and save.

VIEW SOURCE

Instance Properties

The mechanism used to persist key-value pairs.

VIEW SOURCE

Static Properties

Metadata key under which the actual data is stored.

VIEW SOURCE

Classes

RichStorage.Wrapper

goog.storage.RichStorage

new RichStorage( `mechanism` )

Instance Methods

`this.`get( `key` ) `→` `*`

`this.`getWrapper( `key` ) `→` `(Object|undefined)`

`this.`remove( `key` ) `→` `void`

`this.`set( `key`, `value` ) `→` `void`

Instance Properties

`this.`mechanism `→` `(goog.storage.mechanism.Mechanism|null)`

Static Properties

RichStorage.DATA_KEY `→` `string`

Classes

goog.storage.RichStorage

new RichStorage( mechanism )

Instance Methods

this.get( key ) → *

this.getWrapper( key ) → (Object|undefined)

this.remove( key ) → void

this.set( key, value ) → void

Instance Properties

this.mechanism → (goog.storage.mechanism.Mechanism|null)

Static Properties

RichStorage.DATA_KEY → string

Classes

new RichStorage( `mechanism` )

`this.`get( `key` ) `→` `*`

`this.`getWrapper( `key` ) `→` `(Object|undefined)`

`this.`remove( `key` ) `→` `void`

`this.`set( `key`, `value` ) `→` `void`

`this.`mechanism `→` `(goog.storage.mechanism.Mechanism|null)`

RichStorage.DATA_KEY `→` `string`