docs(nativestorage): add usage

2026-05-02 00:07:23 +08:00 · 2016-07-17 02:35:31 -04:00
parent af5d4ad87f
commit d03ff962e3
1 changed files with 18 additions and 0 deletions
@@ -1,6 +1,24 @@
 import {Plugin, Cordova} from './plugin';
 /**
 * @name Native Storage
+ * @description
+ * 
+ * @usage
+ * ```typescript
+ * import {NativeStorage} from 'ionic-native';
+ *
+ * NativeStorage.setItem('myitem', {property: 'value', anotherProperty: 'anotherValue'})
+ *   .then(
+ *     () => console.log('Stored item!'),
+ *     error => console.error('Error storing item', error)
+ *   );
+ *
+ * NativeStorage.getItem('myitem')
+ *   .then(
+ *     data => console.log(data),
+ *     error => console.error(error)
+ *   );
+ * ```
 */
@Plugin({
  plugin: 'cordova-plugin-nativestorage',