javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-23 05:58:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(localStorage): add more docs

Browse Source
This commit is contained in:
Mike Hartington
2016-05-03 10:36:35 -04:00
parent 62b97ce4f3
commit 5dddce3898
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
ionic/platform/storage/local-storage.ts
View File

@ -37,6 +37,7 @@ export class LocalStorage extends StorageEngine {
/** /**
* Get the value of a key in LocalStorage * Get the value of a key in LocalStorage
* @param {string} key the key you want to lookup in LocalStorage * @param {string} key the key you want to lookup in LocalStorage
* @returns {Promise} Returns a promise which is resolved when the value has been retrieved
*/ */
get(key: string): Promise<string> { get(key: string): Promise<string> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
@ -53,6 +54,7 @@ export class LocalStorage extends StorageEngine {
* Set a key value pair and save it to LocalStorage * Set a key value pair and save it to LocalStorage
* @param {string} key the key you want to save to LocalStorage * @param {string} key the key you want to save to LocalStorage
* @param {string} value the value of the key you're saving * @param {string} value the value of the key you're saving
* @returns {Promise} Returns a promise which is resolved when the key value pair have been set
*/ */
set(key: string, value: string): Promise<any> { set(key: string, value: string): Promise<any> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
@ -68,6 +70,7 @@ export class LocalStorage extends StorageEngine {
/** /**
* Remove a key from LocalStorage * Remove a key from LocalStorage
* @param {string} key the key you want to remove from LocalStorage * @param {string} key the key you want to remove from LocalStorage
* @returns {Promise} Returns a promise which is resolved when the key has been removed
*/ */
remove(key: string): Promise<any> { remove(key: string): Promise<any> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
@ -80,6 +83,10 @@ export class LocalStorage extends StorageEngine {
}); });
} }
/**
* Clear data stored in LocalStorage
* @returns {Promise} Returns a promise which is resolved when the data have been cleared
*/
clear(): Promise<any> { clear(): Promise<any> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
try { try {