From 713efd720626c68df9a4c8a902eca85bb6dda1eb Mon Sep 17 00:00:00 2001 From: Matt Date: Sun, 8 Jul 2018 17:43:31 +0100 Subject: [PATCH] docs(sqlite): Add interface for transaction callback function argument (#2586) The transaction callback function argument is currently typed as `any`, however this isn't very helpful so I have added a base interface which contains only the `executeSql` function. This function is all that is available on the object returned by WebSQL, but is also available on the full SQLite implementation. --- src/@ionic-native/plugins/sqlite/index.ts | 24 ++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/src/@ionic-native/plugins/sqlite/index.ts b/src/@ionic-native/plugins/sqlite/index.ts index 36bba60a5..c418c20b1 100644 --- a/src/@ionic-native/plugins/sqlite/index.ts +++ b/src/@ionic-native/plugins/sqlite/index.ts @@ -36,14 +36,20 @@ export interface SQLiteDatabaseConfig { /** * @hidden */ -export interface SQLiteTransaction { - start: () => void; +export interface DbTransaction { executeSql: ( - sql: any, - values: any, - success: Function, - error: Function - ) => void; + sql: any, + values: any, + success: Function, + error: Function + ) => void; +} + +/** + * @hidden + */ +export interface SQLiteTransaction extends DbTransaction { + start: () => void; addStatement: ( sql: any, values: any, @@ -74,14 +80,14 @@ export class SQLiteObject { addTransaction(transaction: (tx: SQLiteTransaction) => void): void {} /** - * @param fn {any} + * @param fn {Function} * @returns {Promise} */ @CordovaInstance({ successIndex: 2, errorIndex: 1 }) - transaction(fn: any): Promise { + transaction(fn: (tx: DbTransaction) => void): Promise { return; }