UIZE JavaScript Framework

MODULES Uize.Services.Store

SEARCHEXAMPLESSOURCETO DODEPSTEST

1. Introduction

The Uize.Services.Store module defines a class for a simple key/value store service.

DEVELOPERS: Chris van Rensburg

1.1. Examples

There are no dedicated showcase example pages for the Uize.Services.Store module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Services.Store module...

SEARCH

1.2. Implementation Info

The Uize.Services.Store module defines the Uize.Services.Store class, which is a subclass of Uize.Service.

INHERITANCE CHAIN

Uize.Class −> Uize.Service −> Uize.Services.Store

1.2.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

INSTANCE METHODS

clear | getItem | key | removeItem | setItem

1.2.2. Features Overridden in This Module

The features listed in this section have been overridden in this module.

The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

valueOf

STATIC PROPERTIES

Uize.Services.Store.moduleName | Uize.Services.Store.nonInheritableStatics

1.2.3. Features Inherited From Other Modules

The features listed in this section have been inherited from other modules.

The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

fire | get | is | isMet | kill | met | onChange | once | set | toggle | unmet | unwire | whenever | wire

STATE PROPERTIES

adapter | initialized

STATIC METHODS

Uize.Services.Store.alphastructor | Uize.Services.Store.declare | Uize.Services.Store.doMy | Uize.Services.Store.dualContextMethods | Uize.Services.Store.dualContextProperties | Uize.Services.Store.fire | Uize.Services.Store.get | Uize.Services.Store.instanceMethods | Uize.Services.Store.instanceProperties | Uize.Services.Store.mixins | Uize.Services.Store.omegastructor | Uize.Services.Store.serviceMethods | Uize.Services.Store.set | Uize.Services.Store.singleton | Uize.Services.Store.stateProperties | Uize.Services.Store.staticMethods | Uize.Services.Store.staticProperties | Uize.Services.Store.subclass | Uize.Services.Store.toggle | Uize.Services.Store.unwire | Uize.Services.Store.wire

STATIC PROPERTIES

Uize.Services.Store.pathToResources

1.2.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.2.5. Unit Tests

There is no dedicated unit tests module for the Uize.Services.Store module.

2. Instance Methods

2.1. clear

Lets you clear the entire store, removing all items.

SYNTAX

storeInstance.clear ();

2.1.1. Params

The clear service method has no parameters.

NOTES

this service method is synchronous

IMPLEMENTATION INFO

this feature was introduced in this module

2.2. fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.3. get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.4. getItem

Returns a string, being the value for the item with the specified key.

SYNTAX

itemValueSTR = storeInstance.getItem (paramsOBJ);

2.4.1. Params

The getItem service method supports the following parameters...

2.4.1.1. key

A string, specifying the key of the item whose value should be returned.

If no item with the specified key exists, then this method will return the value undefined and will not produce any errors.

NOTES

this service method is synchronous

IMPLEMENTATION INFO

this feature was introduced in this module

2.5. is

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.6. isMet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.7. key

Returns a string, being the key of the item at the specified index.

SYNTAX

keySTR = storeInstance.key (paramsOBJ);

2.7.1. Params

The key service method supports the following parameters...

2.7.1.1. index

A number, specifying the item for which the key should be determined.

If no item exists at the specified index, then this method will return the value null and will not produce any errors.

NOTES

this service method is synchronous

IMPLEMENTATION INFO

this feature was introduced in this module

2.8. kill

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.9. met

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.10. onChange

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.11. once

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.12. removeItem

Lets you remove the item with the specified key.

SYNTAX

storeInstance.removeItem (paramsOBJ);

2.12.1. Params

The removeItem service method supports the following parameters...

2.12.1.1. key

A string, specifying the key of the item that should be removed.

If no item with the specified key exists, then this method will do nothing - it will not produce any errors.

NOTES

this service method is synchronous

IMPLEMENTATION INFO

this feature was introduced in this module

2.13. set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.14. setItem

Lets you set the item with the specified key to the specified value.

SYNTAX

storeInstance.setItem (paramsOBJ);

2.14.1. Params

The setItem service method supports the following parameters...

2.14.1.1. key

A string, specifying the key of the item whose value should be set.

If an item with the specified key already exists, its value will be set to the new value specified in the value parameter. If not item with the specified key exists, it will be created.

2.14.1.2. value

A string, specifying the value that the item should be set to.

NOTES

this service method is synchronous

IMPLEMENTATION INFO

this feature was introduced in this module

2.15. toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.16. unmet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.17. unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.18. valueOf

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)

IMPLEMENTATION INFO

2.19. whenever

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.20. wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3. State Properties

3.1. adapter

Inherited from Uize.Service.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service)

3.2. initialized

Inherited from Uize.Service.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service)

4. Static Methods

4.1. Uize.Services.Store.alphastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.2. Uize.Services.Store.declare

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.3. Uize.Services.Store.doMy

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.4. Uize.Services.Store.dualContextMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.5. Uize.Services.Store.dualContextProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.6. Uize.Services.Store.fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.7. Uize.Services.Store.get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.8. Uize.Services.Store.instanceMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.9. Uize.Services.Store.instanceProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.10. Uize.Services.Store.mixins

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.11. Uize.Services.Store.omegastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.12. Uize.Services.Store.serviceMethods

Inherited from Uize.Service.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service)
this static feature is inherited by subclasses

4.13. Uize.Services.Store.set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.14. Uize.Services.Store.singleton

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.15. Uize.Services.Store.stateProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.16. Uize.Services.Store.staticMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.17. Uize.Services.Store.staticProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.18. Uize.Services.Store.subclass

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.19. Uize.Services.Store.toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.20. Uize.Services.Store.unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.21. Uize.Services.Store.wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5. Static Properties

5.1. Uize.Services.Store.moduleName

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.2. Uize.Services.Store.nonInheritableStatics

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is not inherited by subclasses

5.3. Uize.Services.Store.pathToResources

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses