From ee79278503f5cc9c1b97e87f2fd740bd9cc969e1 Mon Sep 17 00:00:00 2001 From: Ibby Hadeed Date: Tue, 28 Mar 2017 04:27:49 -0400 Subject: [PATCH] docs(sqlite): improve echoTest and deleteDatabase docs --- src/@ionic-native/plugins/sqlite/index.ts | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/src/@ionic-native/plugins/sqlite/index.ts b/src/@ionic-native/plugins/sqlite/index.ts index 554378ec8..78251187c 100644 --- a/src/@ionic-native/plugins/sqlite/index.ts +++ b/src/@ionic-native/plugins/sqlite/index.ts @@ -6,13 +6,17 @@ declare var sqlitePlugin; export interface SQLiteDatabaseConfig { /** - * Name of the database + * Name of the database. Example: 'my.db' */ name: string; /** - * Location of the database + * Location of the database. Example: 'default' */ location: string; + /** + * iOS Database Location. Example: 'Library' + */ + iosDatabaseLocation: string; } /** @@ -188,7 +192,7 @@ export class SQLite { * * See the plugin docs for an explanation of all options: https://github.com/litehelpers/Cordova-sqlite-storage#opening-a-database * - * @param config the config for opening the database. + * @param config {SQLiteDatabaseConfig} database configuration * @return Promise */ @CordovaCheck() @@ -199,16 +203,18 @@ export class SQLite { } /** + * Verify that both the Javascript and native part of this plugin are installed in your application * @returns {Promise} */ @Cordova() echoTest(): Promise { return; } /** - * @param first + * Deletes a database + * @param config {SQLiteDatabaseConfig} database configuration * @returns {Promise} */ @Cordova() - deleteDatabase(first): Promise { return; } + deleteDatabase(config: SQLiteDatabaseConfig): Promise { return; } }