fix(database): Adding toJSON() method to TransactionResult (#104)

* fix(database): Adding toJSON() method to TransactionResult

* fix(database): Making return type of toJSON explicit

Author: schmidt-sebastian

src/database/api/Reference.ts

@@ -206,7 +206,7 @@ export class Reference extends Query {
    */
   transaction(transactionUpdate: (a: any) => any,
               onComplete?: (a: Error | null, b: boolean, c: DataSnapshot | null) => void,
-              applyLocally?: boolean): Promise<any> {
+              applyLocally?: boolean): Promise<TransactionResult> {
     validateArgCount('Reference.transaction', 1, 3, arguments.length);
     validateWritablePath('Reference.transaction', this.path);
     validateCallback('Reference.transaction', 1, transactionUpdate, false);

src/database/api/TransactionResult.ts

@@ -15,6 +15,7 @@
 */
 
 import { DataSnapshot } from './DataSnapshot';
+import { validateArgCount } from '../../utils/validation';
 
 export class TransactionResult {
   /**
@@ -27,4 +28,12 @@ export class TransactionResult {
   constructor(public committed: boolean, public snapshot: DataSnapshot) {
 
   }
+
+  // Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
+  // for end-users
+  toJSON(): object {
+    validateArgCount('TransactionResult.toJSON', 0, 1, arguments.length);
+    return { committed: this.committed, snapshot: this.snapshot.toJSON() };
+  }
+
 }

tests/database/transaction.test.ts

@@ -56,6 +56,16 @@ describe('Transaction Tests', function() {
     expect(eventHelper.waiter()).to.equal(true);
   });
 
+  it('Transaction result can be converted to JSON.', function() {
+    const node = (getRandomNode() as Reference);
+
+    return node.transaction(() => {
+      return 42;
+    }).then(transactionResult => {
+      expect(transactionResult.toJSON()).to.deep.equal({ committed: true, snapshot: 42 });
+    });
+  });
+
   it('Non-aborted transaction sets committed to true in callback.', function(done) {
     const node = (getRandomNode() as Reference);