#120 Chaining range types

Author: EddyVerbruggen

docs/DATABASE.md

@@ -90,14 +90,25 @@ Let's say we have the structure as defined at `setValue`, then use this query to
             // order by company.country
             orderBy: {
                 type: firebase.QueryOrderByType.CHILD,
-                value: 'country' // mandatory when type is 'child'
-            },
-            // but only companies named 'Telerik'
-            // (this range relates to the orderBy clause)
-            range: {
-                type: firebase.QueryRangeType.EQUAL_TO,
-                value: 'Bulgaria'
+                value: 'since' // mandatory when type is 'child'
             },
+            // but only companies 'since' a certain year (Telerik's value is 2000, which is imaginary btw)
+            // use either a 'range'
+            //range: {
+            //    type: firebase.QueryRangeType.EQUAL_TO,
+            //    value: 2000
+            ///},
+            // .. or 'chain' ranges like this:
+            ranges: [
+              {
+                  type: firebase.QueryRangeType.START_AT,
+                  value: 1999
+              },
+              {
+                  type: firebase.QueryRangeType.END_AT,
+                  value: 2000
+              }
+            ],
             // only the first 2 matches
             // (note that there's only 1 in this case anyway)
             limit: {
@@ -108,7 +119,7 @@ Let's say we have the structure as defined at `setValue`, then use this query to
     );
 ```
 
-For supported values of the orderBy/range/limit's `type` properties, take a look at the [`firebase-common.d.ts`](firebase-common.d.ts) TypeScript definitions in this repo.
+For supported values of the orderBy/range/ranges/limit's `type` properties, take a look at the [`firebase-common.d.ts`](firebase-common.d.ts) TypeScript definitions in this repo.
 
 ### update
 Changes the values of the keys specified in the dictionary without overwriting other keys at this location.

firebase.android.js

@@ -941,6 +941,27 @@ firebase.query = function (updateCallback, path, options) {
         }
       }
 
+      // ranges
+      if (options.ranges) {
+        for (var i=0; i < options.ranges.length; i++) {
+          var range = options.ranges[i];
+          if (!range.value) {
+            reject("Please set ranges["+i+"].value");
+            return;
+          }
+          if (range.type === firebase.QueryRangeType.START_AT) {
+            query = query.startAt(range.value);
+          } else if (range.type === firebase.QueryRangeType.END_AT) {
+            query = query.endAt(range.value);
+          } else if (range.type === firebase.QueryRangeType.EQUAL_TO) {
+            query = query.equalTo(range.value);
+          } else {
+            reject("Invalid ranges["+i+"].type, use constants like firebase.QueryRangeType.START_AT");
+            return;
+          }
+        }
+      }
+
       // limit
       if (options.limit && options.limit.type) {
         if (!options.limit.value) {

firebase.d.ts

@@ -28,6 +28,11 @@ declare module "nativescript-plugin-firebase" {
         storageBucket?: string;
     }
 
+    export interface QueryRangeOption {
+        type: QueryRangeType;
+        value: string;
+    }
+
     /**
      * The options object passed into the query function.
      */
@@ -45,11 +50,15 @@ declare module "nativescript-plugin-firebase" {
 
         /**
          * You can further restrict the returned results by specifying restrictions.
+         * Need more than one range restriction? Use 'ranges' instead.
          */
-        range?: {
-            type: QueryRangeType;
-            value: string;
-        }
+        range?: QueryRangeOption;
+
+        /**
+         * Same as 'range', but for a 'chain of ranges'.
+         * You can further restrict the returned results by specifying restrictions.
+         */
+        ranges?: QueryRangeOption[];
 
         /**
          * You can limit the number of returned rows if you want to.

firebase.ios.js

@@ -984,6 +984,27 @@ firebase.query = function (updateCallback, path, options) {
         }
       }
 
+      // ranges
+      if (options.ranges) {
+        for (var i=0; i < options.ranges.length; i++) {
+          var range = options.ranges[i];
+          if (!range.value) {
+            reject("Please set ranges["+i+"].value");
+            return;
+          }
+          if (range.type === firebase.QueryRangeType.START_AT) {
+            query = query.queryStartingAtValue(range.value);
+          } else if (range.type === firebase.QueryRangeType.END_AT) {
+            query = query.queryEndingAtValue(range.value);
+          } else if (range.type === firebase.QueryRangeType.EQUAL_TO) {
+            query = query.queryEqualToValue(range.value);
+          } else {
+            reject("Invalid ranges["+i+"].type, use constants like firebase.QueryRangeType.START_AT");
+            return;
+          }
+        }
+      }
+
       // limit
       if (options.limit && options.limit.type) {
         if (!options.limit.value) {