inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added JSDocs for services (#2949)

Browse Source
This commit is contained in:
Andy Stark
2018-02-14 14:20:10 +00:00
committed by Eugenio Romano
parent 8bfac2f9f8
commit 9887d8bca4
16 changed files with 182 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
lib/core/services/storage.service.ts
View File

@@ -27,6 +27,10 @@ export class StorageService {
this.useLocalStorage = this.storageAvailable('localStorage');
}
/**
* Gets an item.
* @param key Key to identify the item
*/
getItem(key: string): string | null {
if (this.useLocalStorage) {
return localStorage.getItem(key);
@@ -35,6 +39,11 @@ export class StorageService {
}
}
/**
* Stores an item
* @param key Key to identify the item
* @param data Data to store
*/
setItem(key: string, data: string) {
if (this.useLocalStorage) {
localStorage.setItem(key, data);
@@ -43,6 +52,7 @@ export class StorageService {
}
}
/** Removes all currently stored items. */
clear() {
if (this.useLocalStorage) {
localStorage.clear();
@@ -51,6 +61,10 @@ export class StorageService {
}
}
/**
* Removes a single item.
* @param key Key to identify the item
*/
removeItem(key: string) {
if (this.useLocalStorage) {
localStorage.removeItem(key);
@@ -59,6 +73,10 @@ export class StorageService {
}
}
/**
* Is any item currently stored under `key`?
* @param key Key identifying item to check
*/
hasItem(key: string): boolean {
if (this.useLocalStorage) {
return localStorage.getItem(key) ? true : false;