ember-cli-storagekit
Version:
A thin layer on top of the HTML5 localStorage and sessionStorage services
992 lines • 32.7 kB
JSON
{
"project": {
"name": "ember-cli-storagekit",
"description": "A thin layer on top of the HTML5 localStorage and sessionStorage services",
"version": "0.4.0.9e0c4433"
},
"files": {
"addon/adapters/abstract.js": {
"name": "addon/adapters/abstract.js",
"modules": {
"adapters": 1
},
"classes": {
"BaseAdapter": 1
},
"fors": {},
"namespaces": {}
},
"addon/adapters/instance.js": {
"name": "addon/adapters/instance.js",
"modules": {},
"classes": {
"InstanceAdapter": 1
},
"fors": {},
"namespaces": {}
},
"addon/adapters/local.js": {
"name": "addon/adapters/local.js",
"modules": {},
"classes": {
"LocalAdapter": 1
},
"fors": {},
"namespaces": {}
},
"addon/adapters/session.js": {
"name": "addon/adapters/session.js",
"modules": {},
"classes": {
"SessionAdapter": 1
},
"fors": {},
"namespaces": {}
},
"addon/mixins/build-namespace.js": {
"name": "addon/mixins/build-namespace.js",
"modules": {
"mixins": 1
},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/serializers/json.js": {
"name": "addon/serializers/json.js",
"modules": {
"serializers": 1
},
"classes": {
"JsonSerializer": 1
},
"fors": {},
"namespaces": {}
},
"addon/services/base-storage.js": {
"name": "addon/services/base-storage.js",
"modules": {
"services": 1
},
"classes": {
"BaseStorageService": 1
},
"fors": {},
"namespaces": {}
},
"addon/services/instance-storage.js": {
"name": "addon/services/instance-storage.js",
"modules": {},
"classes": {
"InstanceStorageService": 1
},
"fors": {},
"namespaces": {}
},
"addon/services/local-storage.js": {
"name": "addon/services/local-storage.js",
"modules": {},
"classes": {
"LocalStorageService": 1
},
"fors": {},
"namespaces": {}
},
"addon/services/session-storage.js": {
"name": "addon/services/session-storage.js",
"modules": {},
"classes": {
"ObjectStorageService": 1
},
"fors": {},
"namespaces": {}
},
"addon/services/storage.js": {
"name": "addon/services/storage.js",
"modules": {},
"classes": {
"StorageService": 1
},
"fors": {},
"namespaces": {}
},
"addon/utilities/storage-support.js": {
"name": "addon/utilities/storage-support.js",
"modules": {
"utilities": 1
},
"classes": {
"StorageSupportUtility": 1
},
"fors": {},
"namespaces": {}
}
},
"modules": {
"ember-cli-storagekit": {
"name": "ember-cli-storagekit",
"submodules": {
"adapters": 1,
"mixins": 1,
"serializers": 1,
"services": 1,
"utilities": 1
},
"elements": {},
"classes": {
"BaseAdapter": 1,
"InstanceAdapter": 1,
"LocalAdapter": 1,
"SessionAdapter": 1,
"JsonSerializer": 1,
"BaseStorageService": 1,
"InstanceStorageService": 1,
"LocalStorageService": 1,
"ObjectStorageService": 1,
"StorageService": 1,
"StorageSupportUtility": 1
},
"fors": {},
"namespaces": {},
"file": "addon/utilities/storage-support.js",
"line": 10
},
"adapters": {
"name": "adapters",
"submodules": {},
"elements": {},
"classes": {
"BaseAdapter": 1,
"InstanceAdapter": 1,
"LocalAdapter": 1,
"SessionAdapter": 1
},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "ember-cli-storagekit",
"namespace": "",
"file": "addon/adapters/session.js",
"line": 10
},
"mixins": {
"name": "mixins",
"submodules": {},
"elements": {},
"classes": {},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "ember-cli-storagekit",
"namespace": "",
"file": "addon/mixins/build-namespace.js",
"line": 5
},
"serializers": {
"name": "serializers",
"submodules": {},
"elements": {},
"classes": {
"JsonSerializer": 1
},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "ember-cli-storagekit",
"namespace": "",
"file": "addon/serializers/json.js",
"line": 12
},
"services": {
"name": "services",
"submodules": {},
"elements": {},
"classes": {
"BaseStorageService": 1,
"InstanceStorageService": 1,
"LocalStorageService": 1,
"ObjectStorageService": 1,
"StorageService": 1
},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "ember-cli-storagekit",
"namespace": "",
"file": "addon/services/storage.js",
"line": 8,
"description": "Storage Service acts a container for housing each storage service type that is available."
},
"utilities": {
"name": "utilities",
"submodules": {},
"elements": {},
"classes": {
"StorageSupportUtility": 1
},
"fors": {},
"is_submodule": 1,
"namespaces": {},
"module": "ember-cli-storagekit",
"namespace": "",
"file": "addon/utilities/storage-support.js",
"line": 10
}
},
"classes": {
"BaseAdapter": {
"name": "BaseAdapter",
"shortname": "BaseAdapter",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "adapters",
"namespace": "",
"file": "addon/adapters/abstract.js",
"line": 9,
"extends": "Ember.Object",
"uses": [
"EmberCliStoragekit/Mixins/BuildNamespace"
],
"access": "public",
"tagname": ""
},
"InstanceAdapter": {
"name": "InstanceAdapter",
"shortname": "InstanceAdapter",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "adapters",
"namespace": "",
"file": "addon/adapters/instance.js",
"line": 9,
"extends": "EmberCliStoragekit.AbstractAdapter",
"requires": [
"Ember.Map"
],
"access": "public",
"tagname": ""
},
"LocalAdapter": {
"name": "LocalAdapter",
"shortname": "LocalAdapter",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "adapters",
"namespace": "",
"file": "addon/adapters/local.js",
"line": 10,
"extends": "EmberCliStoragekit.AbstractAdapter",
"access": "public",
"tagname": ""
},
"SessionAdapter": {
"name": "SessionAdapter",
"shortname": "SessionAdapter",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "adapters",
"namespace": "",
"file": "addon/adapters/session.js",
"line": 10,
"extends": "EmberCliStoragekit.AbstractAdapter",
"access": "public",
"tagname": ""
},
"JsonSerializer": {
"name": "JsonSerializer",
"shortname": "JsonSerializer",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "serializers",
"namespace": "",
"file": "addon/serializers/json.js",
"line": 12,
"extends": "Ember.Object",
"access": "public",
"tagname": ""
},
"BaseStorageService": {
"name": "BaseStorageService",
"shortname": "BaseStorageService",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "services",
"namespace": "",
"file": "addon/services/base-storage.js",
"line": 8,
"extends": "Ember.Service",
"access": "public",
"tagname": ""
},
"InstanceStorageService": {
"name": "InstanceStorageService",
"shortname": "InstanceStorageService",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "services",
"namespace": "",
"file": "addon/services/instance-storage.js",
"line": 8,
"extends": "EmberCliStorageKit.BaseStorage",
"access": "public",
"tagname": ""
},
"LocalStorageService": {
"name": "LocalStorageService",
"shortname": "LocalStorageService",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "services",
"namespace": "",
"file": "addon/services/local-storage.js",
"line": 8,
"extends": "EmberCliStorageKit.BaseStorage",
"access": "public",
"tagname": ""
},
"ObjectStorageService": {
"name": "ObjectStorageService",
"shortname": "ObjectStorageService",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "services",
"namespace": "",
"file": "addon/services/session-storage.js",
"line": 8,
"extends": "EmberCliStorageKit.BaseStorage",
"access": "public",
"tagname": ""
},
"StorageService": {
"name": "StorageService",
"shortname": "StorageService",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "services",
"namespace": "",
"file": "addon/services/storage.js",
"line": 8,
"description": "Storage Service acts a container for housing each storage service type that is available.",
"extends": "Ember.Service",
"access": "public",
"tagname": ""
},
"StorageSupportUtility": {
"name": "StorageSupportUtility",
"shortname": "StorageSupportUtility",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli-storagekit",
"submodule": "utilities",
"namespace": "",
"file": "addon/utilities/storage-support.js",
"line": 10,
"extends": "Ember.Namespace",
"access": "public",
"tagname": ""
}
},
"elements": {},
"classitems": [
{
"file": "addon/adapters/abstract.js",
"line": 18,
"itemtype": "property",
"name": "storage The storage service to delegate to",
"type": "*",
"access": "private",
"tagname": "",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/abstract.js",
"line": 24,
"description": "The serializer to use when storing values into storage",
"itemtype": "property",
"name": "serializer",
"type": "*",
"access": "private",
"tagname": "",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/abstract.js",
"line": 31,
"description": "Sets a value into storage under a provided key",
"itemtype": "method",
"name": "setItem",
"params": [
{
"name": "key",
"description": "The key name to store the given value under",
"type": "String"
},
{
"name": "value",
"description": "A value to store under a specified key",
"type": "*"
}
],
"access": "public",
"tagname": "",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/abstract.js",
"line": 42,
"description": "Gets a value from storage based on a given key",
"itemtype": "method",
"name": "getItem",
"params": [
{
"name": "key",
"description": "The key to use when retrieving a value from storage",
"type": "String"
}
],
"return": {
"description": "The value retrieved from storage based on the given key"
},
"access": "public",
"tagname": "",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/abstract.js",
"line": 53,
"description": "Removes a value from storage using a given key",
"itemtype": "method",
"name": "removeItem",
"params": [
{
"name": "key",
"description": "The key/value to remove from storage",
"type": "String"
}
],
"access": "public",
"tagname": "",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/abstract.js",
"line": 63,
"itemtype": "method",
"name": "key",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/abstract.js",
"line": 70,
"description": "Returns all the keys that are currently in the storage \"world\" in sorted order\n(where the namespace defines the world boundary).",
"itemtype": "method",
"name": "keys",
"access": "public",
"tagname": "",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/abstract.js",
"line": 83,
"description": "Clears all key/value pairs from storage",
"itemtype": "method",
"name": "clear",
"access": "public",
"tagname": "",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/abstract.js",
"line": 92,
"description": "The current length/number of items in storage",
"itemtype": "method",
"name": "length",
"return": {
"description": "The number of items in storage",
"type": "Number"
},
"access": "public",
"tagname": "",
"class": "BaseAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/instance.js",
"line": 22,
"override": "",
"class": "InstanceAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/instance.js",
"line": 29,
"override": "",
"class": "InstanceAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/instance.js",
"line": 36,
"override": "",
"class": "InstanceAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/instance.js",
"line": 43,
"override": "",
"class": "InstanceAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/adapters/instance.js",
"line": 58,
"override": "",
"class": "InstanceAdapter",
"module": "ember-cli-storagekit",
"submodule": "adapters"
},
{
"file": "addon/mixins/build-namespace.js",
"line": 12,
"description": "Namespace to prepend to each stored key, separated by a colon (:).\n\nEx.\n\n```javascript\n 'my-namespace:my-key'\n```",
"itemtype": "property",
"name": "namespace",
"type": "String",
"default": "\"\"",
"class": "JsonSerializer",
"module": "ember-cli-storagekit",
"submodule": "mixins"
},
{
"file": "addon/mixins/build-namespace.js",
"line": 25,
"itemtype": "property",
"name": "_namespace",
"type": "String",
"access": "private",
"tagname": "",
"class": "JsonSerializer",
"module": "ember-cli-storagekit",
"submodule": "mixins"
},
{
"file": "addon/mixins/build-namespace.js",
"line": 43,
"itemtype": "method",
"name": "namespaceKey",
"params": [
{
"name": "key",
"description": "A key to be namespaced.",
"type": "String"
}
],
"access": "public",
"tagname": "",
"class": "JsonSerializer",
"module": "ember-cli-storagekit",
"submodule": "mixins"
},
{
"file": "addon/mixins/build-namespace.js",
"line": 53,
"description": "strips the namespace from a namespaced key",
"itemtype": "method",
"name": "stripNamespace",
"params": [
{
"name": "key",
"description": "A namespaced key to be stripped",
"type": "String"
}
],
"return": {
"description": "The key with its namespace removed",
"type": "String"
},
"access": "public",
"tagname": "",
"class": "JsonSerializer",
"module": "ember-cli-storagekit",
"submodule": "mixins"
},
{
"file": "addon/mixins/build-namespace.js",
"line": 66,
"description": "Determines whether or not a provided key is namespaced.",
"itemtype": "method",
"name": "isNamespaced",
"params": [
{
"name": "key",
"description": "The key to check the namespace status of.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"class": "JsonSerializer",
"module": "ember-cli-storagekit",
"submodule": "mixins"
},
{
"file": "addon/mixins/build-namespace.js",
"line": 77,
"description": "Determines whether or not a provided key is namespaced.",
"itemtype": "method",
"name": "isNamespacedKey",
"params": [
{
"name": "key",
"description": "The key to check the namespace status of.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"deprecated": true,
"deprecationMessage": "please use #isNamespaced instead.",
"class": "JsonSerializer",
"module": "ember-cli-storagekit",
"submodule": "mixins"
},
{
"file": "addon/serializers/json.js",
"line": 20,
"itemtype": "method",
"name": "serialize",
"access": "public",
"tagname": "",
"class": "JsonSerializer",
"module": "ember-cli-storagekit",
"submodule": "serializers"
},
{
"file": "addon/serializers/json.js",
"line": 28,
"itemtype": "method",
"name": "deserialize",
"access": "public",
"tagname": "",
"class": "JsonSerializer",
"module": "ember-cli-storagekit",
"submodule": "serializers"
},
{
"file": "addon/services/base-storage.js",
"line": 16,
"description": "The adapter being delegated to",
"itemtype": "property",
"name": "adapter",
"type": "*",
"access": "private",
"tagname": "",
"class": "BaseStorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/base-storage.js",
"line": 23,
"description": "Delegates a setItem call to the underlying storage source",
"itemtype": "method",
"name": "setItem",
"params": [
{
"name": "key",
"description": "",
"type": "String"
},
{
"name": "value",
"description": "",
"type": "*"
}
],
"access": "public",
"tagname": "",
"class": "BaseStorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/base-storage.js",
"line": 34,
"description": "Delegates a getItem call to the underlying storage source",
"itemtype": "method",
"name": "getItem",
"params": [
{
"name": "key",
"description": "",
"type": "String"
}
],
"access": "public",
"tagname": "",
"class": "BaseStorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/base-storage.js",
"line": 44,
"description": "Delegates a removeItem call to the underlying storage source",
"itemtype": "method",
"name": "removeItem",
"params": [
{
"name": "key",
"description": "",
"type": "String"
}
],
"access": "public",
"tagname": "",
"class": "BaseStorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/base-storage.js",
"line": 54,
"description": "Delegates a key call to the underlying storage source.",
"itemtype": "method",
"name": "key",
"params": [
{
"name": "index",
"description": "The index of the key to retrieve.",
"type": "Number"
}
],
"return": {
"description": "The key at the given index or null if it does not exist.",
"type": "String|null"
},
"class": "BaseStorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/base-storage.js",
"line": 64,
"description": "Delegates a keys call to the underlying storage source",
"class": "BaseStorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/base-storage.js",
"line": 71,
"description": "Clears the underlying storage source",
"itemtype": "method",
"name": "clear",
"access": "public",
"tagname": "",
"class": "BaseStorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/base-storage.js",
"line": 80,
"description": "Delegates a length call the underlying storage source",
"itemtype": "method",
"name": "length",
"access": "public",
"tagname": "",
"class": "BaseStorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/storage.js",
"line": 17,
"description": "a localStorage service object",
"itemtype": "property",
"name": "local",
"type": "EmberCliStoragekit.LocalStorageService",
"class": "StorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/storage.js",
"line": 23,
"description": "a sessionStorage service object",
"itemtype": "property",
"name": "session",
"type": "EmberCliStoragekit.SessionStorageService",
"class": "StorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/services/storage.js",
"line": 29,
"description": "an objectStorage service instance.",
"itemtype": "property",
"name": "instance",
"type": "EmberCliStoragekit.InstanceStorageService",
"class": "StorageService",
"module": "ember-cli-storagekit",
"submodule": "services"
},
{
"file": "addon/utilities/storage-support.js",
"line": 18,
"description": "The environment global object (ex. window)",
"itemtype": "property",
"name": "global",
"type": "*",
"access": "private",
"tagname": "",
"class": "StorageSupportUtility",
"module": "ember-cli-storagekit",
"submodule": "utilities"
},
{
"file": "addon/utilities/storage-support.js",
"line": 25,
"description": "Determines whether or not the current environment has support for a given type of storage.\nex. localStorage, sessionStorage",
"itemtype": "method",
"name": "has",
"params": [
{
"name": "type",
"description": "The storage type to be checked for support in the current environment.",
"type": "String"
}
],
"return": {
"description": "Whether or not the given storage type is supported.",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"class": "StorageSupportUtility",
"module": "ember-cli-storagekit",
"submodule": "utilities"
}
],
"warnings": [
{
"message": "unknown tag: override",
"line": " addon/adapters/instance.js:22"
},
{
"message": "unknown tag: override",
"line": " addon/adapters/instance.js:29"
},
{
"message": "unknown tag: override",
"line": " addon/adapters/instance.js:36"
},
{
"message": "unknown tag: override",
"line": " addon/adapters/instance.js:43"
},
{
"message": "unknown tag: override",
"line": " addon/adapters/instance.js:58"
},
{
"message": "Missing item type",
"line": " addon/adapters/instance.js:22"
},
{
"message": "Missing item type",
"line": " addon/adapters/instance.js:29"
},
{
"message": "Missing item type",
"line": " addon/adapters/instance.js:36"
},
{
"message": "Missing item type",
"line": " addon/adapters/instance.js:43"
},
{
"message": "Missing item type",
"line": " addon/adapters/instance.js:58"
},
{
"message": "Missing item type\nDelegates a keys call to the underlying storage source",
"line": " addon/services/base-storage.js:64"
}
]
}