ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-19 07:38:15 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

[JSDoc] Add annotations

Browse Source 
Bulk-add JSDoc annotations, WTD-1482.
This commit is contained in:
Victor Woeltjen
2015-08-07 11:44:54 -07:00
parent 14f97eae9c
commit c08a460d30
239 changed files with 939 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
platform/persistence/cache/src/CachingPersistenceDecorator.js vendored
View File

@ -31,6 +31,7 @@ define(
* that have been loaded, and keeps them in sync after writes. This allows
* retrievals to occur more quickly after the first load.
*
* @memberof platform/persistence/cache
* @constructor
* @param {string[]} CACHE_SPACES persistence space names which
* should be cached
@ -113,6 +114,7 @@ define(
* decorated service.
* @memberof CachingPersistenceDecorator#
* @returns {Promise.<string[]>} spaces supported
* @memberof platform/persistence/cache.CachingPersistenceDecorator#
*/
listSpaces: function () {
return persistenceService.listSpaces();
@ -122,6 +124,7 @@ define(
* @memberof CachingPersistenceDecorator#
* @param {string} space the space in which to list objects
* @returns {Promise.<string[]>} keys for objects in this space
* @memberof platform/persistence/cache.CachingPersistenceDecorator#
*/
listObjects: function (space) {
return persistenceService.listObjects(space);
@ -136,6 +139,7 @@ define(
* @param {object} value a JSONifiable object to store
* @returns {Promise.<boolean>} an indicator of the success or
* failure of this request
* @memberof platform/persistence/cache.CachingPersistenceDecorator#
*/
createObject: function (space, key, value) {
addToCache(space, key, value);
@ -150,6 +154,7 @@ define(
* @returns {Promise.<object>} a promise for the object; may
* resolve to undefined (if the object does not exist
* in this space)
* @memberof platform/persistence/cache.CachingPersistenceDecorator#
*/
readObject: function (space, key) {
return (cache[space] && cache[space][key]) ?
@ -167,6 +172,7 @@ define(
* @param {object} value a JSONifiable object to store
* @returns {Promise.<boolean>} an indicator of the success or
* failure of this request
* @memberof platform/persistence/cache.CachingPersistenceDecorator#
*/
updateObject: function (space, key, value) {
return persistenceService.updateObject(space, key, value)
@ -185,6 +191,7 @@ define(
* @param {object} value a JSONifiable object to delete
* @returns {Promise.<boolean>} an indicator of the success or
* failure of this request
* @memberof platform/persistence/cache.CachingPersistenceDecorator#
*/
deleteObject: function (space, key, value) {
if (cache[space]) {
@ -198,4 +205,4 @@ define(
return CachingPersistenceDecorator;
}
);
);