goog.storage.ExpiringStorage

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

Provides a storage with expiring keys.

new ExpiringStorage( `mechanism` )

Parameters

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

VIEW SOURCE

Instance Methods

Gets an item from the data storage.

Defined by

goog.storage.RichStorage

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.

Overrides

goog.storage.RichStorage

Parameters

`key`	`string`
	The key to get.
`opt_expired`	`boolean=`
	If true, return expired wrappers as well.

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

Set an item in the storage.

Overrides

goog.storage.RichStorage

Parameters

`key`	`string`
	The key to set.
`value`	`*`
	The value to serialize to a string and save.
`opt_expiration`	`number=`
	The number of miliseconds since epoch (as in goog.now()) when the value is to expire. If the expiration time is not provided, the value will persist as long as possible.

VIEW SOURCE

Instance Properties

The mechanism used to persist key-value pairs.

VIEW SOURCE

Static Functions

Returns the wrapper creation time.

Parameters

`wrapper`	`Object`
	The wrapper.

Returns

(number|undefined)

Wrapper creation time.

VIEW SOURCE

Returns the wrapper expiration time.

Parameters

`wrapper`	`Object`
	The wrapper.

Returns

(number|undefined)

Wrapper expiration time.

VIEW SOURCE

Checks if the data item has expired.

Parameters

`wrapper`	`Object`
	The wrapper.

Returns

boolean

True if the item has expired.

VIEW SOURCE

Static Properties

Metadata key under which the creation time is stored.

VIEW SOURCE

Metadata key under which the expiration time is stored.

VIEW SOURCE

goog.storage.ExpiringStorage

new ExpiringStorage( `mechanism` )

Instance Methods

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

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

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

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

Instance Properties

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

Static Functions

ExpiringStorage.getCreationTime( `wrapper` ) `→` `(number|undefined)`

ExpiringStorage.getExpirationTime( `wrapper` ) `→` `(number|undefined)`

ExpiringStorage.isExpired( `wrapper` ) `→` `boolean`

Static Properties

ExpiringStorage.CREATION_TIME_KEY `→` `string`

ExpiringStorage.EXPIRATION_TIME_KEY `→` `string`

goog.storage.ExpiringStorage

new ExpiringStorage( mechanism )

Instance Methods

this.get( key ) → *

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

this.remove( key ) → void

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

Instance Properties

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

Static Functions

ExpiringStorage.getCreationTime( wrapper ) → (number|undefined)

ExpiringStorage.getExpirationTime( wrapper ) → (number|undefined)

ExpiringStorage.isExpired( wrapper ) → boolean

Static Properties

ExpiringStorage.CREATION_TIME_KEY → string

ExpiringStorage.EXPIRATION_TIME_KEY → string

new ExpiringStorage( `mechanism` )

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

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

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

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

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

ExpiringStorage.getCreationTime( `wrapper` ) `→` `(number|undefined)`

ExpiringStorage.getExpirationTime( `wrapper` ) `→` `(number|undefined)`

ExpiringStorage.isExpired( `wrapper` ) `→` `boolean`

ExpiringStorage.CREATION_TIME_KEY `→` `string`

ExpiringStorage.EXPIRATION_TIME_KEY `→` `string`