Make ServerValue.increment() public (#2852)

Author: schmidt-sebastian

packages/database-types/index.d.ts

@@ -121,9 +121,8 @@ export interface Reference extends Query {
 }
 
 export interface ServerValue {
-  TIMESTAMP: {
-    '.sv': string;
-  };
+  TIMESTAMP: Object;
+  increment(delta: number) : Object;
 }
 
 export interface ThenableReference extends Reference, Promise<Reference> {}

packages/database/CHANGELOG.md

@@ -1,7 +1,10 @@
 # Unreleased
+- [feature] Added ServerValue.increment() to support atomic field value increments
+  without transactions.
+
+# Released
 - [fixed] Fixed an issue that caused large numeric values with leading zeros to
   not always be sorted correctly.
-
 - [changed] Internal cleanup to Node.JS support.
 
 # 6.4.0

packages/database/src/api/Database.ts

@@ -40,10 +40,10 @@ export class Database implements FirebaseService {
     TIMESTAMP: {
       '.sv': 'timestamp'
     },
-    _increment: (x: number) => {
+    increment: (delta: number) => {
       return {
         '.sv': {
-          'increment': x
+          'increment': delta
         }
       };
     }

packages/database/test/servervalues.test.ts

@@ -47,7 +47,7 @@ describe('ServerValue tests', () => {
     // node (i.e. ChildrenNode.EMPTY_NODE) because there is not yet any synced
     // data.
     const node = getRandomNode() as Reference;
-    await node.set(Database.ServerValue._increment(1));
+    await node.set(Database.ServerValue.increment(1));
   });
 
   describe('handles increments', () => {
@@ -64,7 +64,7 @@ describe('ServerValue tests', () => {
           node.database.goOffline();
         }
 
-        const addOne = Database.ServerValue._increment(1);
+        const addOne = Database.ServerValue.increment(1);
 
         const values: any = [];
         const expected: any = [];
@@ -110,7 +110,7 @@ describe('ServerValue tests', () => {
     });
 
     await node.update({
-      'child/increment': Database.ServerValue._increment(1),
+      'child/increment': Database.ServerValue.increment(1),
       'literal': 5
     });
     expect(value).to.deep.equal({
@@ -121,7 +121,7 @@ describe('ServerValue tests', () => {
     });
 
     await node.update({
-      'child/increment': Database.ServerValue._increment(41)
+      'child/increment': Database.ServerValue.increment(41)
     });
     expect(value).to.deep.equal({
       'literal': 5,
@@ -141,7 +141,7 @@ describe('ServerValue tests', () => {
     const racers = 100;
 
     for (let i = 0; i < racers; i++) {
-      all.push(node.set(Database.ServerValue._increment(1)));
+      all.push(node.set(Database.ServerValue.increment(1)));
     }
     await Promise.all(all);
 

packages/firebase/index.d.ts

@@ -6920,6 +6920,15 @@ declare namespace firebase.database.ServerValue {
    * ```
    */
   var TIMESTAMP: Object;
+  
+  /**
+   * Returns a placeholder value that can be used to atomically increment the 
+   * current database value by the provided delta.
+   *
+   * @param delta the amount to modify the current value atomically.
+   * @return a placeholder value for modifying data atomically server-side.
+   */
+  function increment(delta: number) : Object;
 }
 
 /**