feat(docs): note added about order of query params - #302

Author: prescottprue

docs/api/enhancer.md

@@ -53,7 +53,7 @@ along side applyMiddleware.
     -   `config.profileParamsToPopulate` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Parameters within
         profile object to populate. As of `v2.0.0` data is only loaded for population, not actually automatically populated
         (allows access to both unpopulated and populated profile data).
-    -   `config.autoPopulateProfile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** **NOTE**: Not yet enabled for v2.0.0. Whether or not to
+    -   `config.autoPopulateProfile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** **NOTE**: Now enabled for v2.0.0. Whether or not to
         automatically populate profile with data loaded through profileParamsToPopulate config. (default: `true`)
     -   `config.setProfilePopulateResults` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to
         call SET actions for data that results from populating profile to redux under

docs/queries.md

@@ -151,6 +151,25 @@ firebaseConnect([
 
 ## Query Params
 
+**Note:** `orderByChild`, `orderByValue`, and `orderByPriority` enable automatic parsing of query params that follow them for convince. This means that the order of query params can affect which query is created. For example:
+
+```js
+// Works since limitToFirst and startAt are parsed into numbers
+queryParams: [`limitToFirst=${limitToFirst}`, `startAt=${startAt}`, 'orderByValue'],
+
+// COULD CAUSE UNEXPECTED BEHAVIOR!!! Values passed to limitToFirst and startAt will remain as strings (i.e not parsed)
+queryParams: ['orderByValue', `limitToFirst=${limitToFirst}`, `startAt=${startAt}`],
+```
+
+If you would like to prevent parsing yourself (i.e. keep limit values as strings), you can pass [`notParsed`](#notParsed) as a queryParam:
+
+```js
+// limitToFirst and startAt remain as strings and are NOT automatically parsed
+queryParams: ['notParsed', `limitToFirst=${limitToFirst}`, `startAt=${startAt}`, 'orderByValue'],
+```
+
+More on [`notParsed` below](#notParsed)
+
 ## orderByChild
 To order the query by a child within each object, use orderByChild.
 
@@ -161,8 +180,8 @@ Ordering a list of todos by the text parameter of the todo item (placing them in
 
 ```javascript
 firebaseConnect([
-  '/todos#orderByChild=text'
-  // { path: '/todos', queryParams: [ 'orderByChild=text' ]} // object notation
+  { path: '/todos', queryParams: [ 'orderByChild=text' ]}
+  '/todos#orderByChild=text' // string notation
 ])
 ```
 
@@ -177,8 +196,8 @@ Ordering a list of todos based on their key (puts them in order of when they wer
 
 ```javascript
 firebaseConnect([
-  '/todos#orderByKey'
-  // { path: '/todos', queryParams: [ 'orderByKey' ]} // object notation
+  { path: '/todos', queryParams: [ 'orderByKey' ]}
+  // '/todos#orderByKey' // string notation
 ])
 ```
 
@@ -192,8 +211,8 @@ Ordering a list of score's based on score's value
 
 ```javascript
 firebaseConnect([
-  `scores#orderByValue`
-  // { path: '/scores', queryParams: [ 'orderByValue' ] } // object notation
+  { path: '/scores', queryParams: [ 'orderByValue' ] }
+  // `scores#orderByValue` // string notation
 ])
 ```
 
@@ -207,8 +226,8 @@ Ordering a list based on priorities
 
 ```javascript
 firebaseConnect([
-  `scores#orderByPriority`
-  // { path: '/scores', queryParams: [ 'orderByPriority' ] } // object notation
+  { path: '/scores', queryParams: [ 'orderByPriority' ] }
+  // `scores#orderByPriority` // string notation
 ])
 ```
 
@@ -222,16 +241,16 @@ Limit query results to the first n number of results.
 
   ```javascript
   firebaseConnect([
-    '/todos#limitToFirst'
-    // { path: '/todos', queryParams: [ 'limitToFirst=1' ] } // object notation
+    { path: '/todos', queryParams: [ 'limitToFirst=1' ] }
+    // '/todos#limitToFirst' // string notation
   ])
   ```
 2. Displaying only the first 10 todo items
 
   ```javascript
   firebaseConnect([
-    '/todos#limitToFirst=10'
-    // { path: '/todos', queryParams: [ 'orderByChild=createdBy', 'equalTo=123' ] } // object notation
+    { path: '/todos', queryParams: [ 'orderByChild=createdBy', 'equalTo=123' ] }
+    // '/todos#limitToFirst=10' // string notation
   ])
   ```
 
@@ -245,16 +264,16 @@ Limit query results to the last n number of results
 
   ```javascript
   firebaseConnect([
-    '/todos#limitToLast'
-    // { path: '/todos', queryParams: [ 'limitToLast' ] } // object notation
+    { path: '/todos', queryParams: [ 'limitToLast' ] }
+    // '/todos#limitToLast' // string notation
   ])
   ```
 2. Only the **last 10** todo items
 
   ```javascript
   firebaseConnect([
-    '/todos#limitToLast=10'
-    // { path: '/todos', queryParams: [ 'limitToLast=10' ] } // object notation
+    { path: '/todos', queryParams: [ 'limitToLast=10' ] }
+    // '/todos#limitToLast=10' // string notation
   ])
   ```
 
@@ -269,22 +288,22 @@ Start query at a specific location by providing the specific number or value
 1. Starting at the fifth item
   ```js
   firebaseConnect([
-    'todos#startAt=5&limitToFirst=2'
-    // { path: '/todos', queryParams: [ 'startAt=5', 'limitToFirst=2' ] } // object notation
+    { path: '/todos', queryParams: [ 'startAt=5', 'limitToFirst=2' ] }
+    // 'todos#startAt=5&limitToFirst=2' // string notation
   ])
   ```
 2. Paginate results
   ```js
   firebaseConnect([
-    'todos#startAt=5&limitToFirst=10'
-    // { path: '/todos', queryParams: [ 'startAt=5', 'limitToFirst=10' ] } // object notation
+    { path: '/todos', queryParams: [ 'startAt=5', 'limitToFirst=10' ] }
+    // 'todos#startAt=5&limitToFirst=10' // string notation
   ])
   ```
 3. Non-number values
 ```js
 firebaseConnect([
-  'todos#startAt=val1&limitToFirst=10'
-  // { path: '/todos', queryParams: [ 'startAt=5', 'limitToFirst=10' ] } // object notation
+  { path: '/todos', queryParams: [ 'startAt=5', 'limitToFirst=10' ] }
+  // 'todos#startAt=val1&limitToFirst=10' // string notation
 ])(SomeComponent)
 ```
 
@@ -298,8 +317,8 @@ End query at a specific location by providing the specific number or value
 1. Usage with startAt
 ```js
 firebaseConnect([
-  'todos#orderByChild=added&startAt=1&endAt=5'
-  // { path: '/todos', queryParams: [ 'orderByChild=added', 'startAt=1', 'endAt=5' ] } // object notation
+  { path: '/todos', queryParams: [ 'orderByChild=added', 'startAt=1', 'endAt=5' ] }
+  // 'todos#orderByChild=added&startAt=1&endAt=5' // string notation
 ])
 ```
 
@@ -314,18 +333,18 @@ The following are internally parsed:
   * `boolean`
   * `number`
 
-This means the actual value will be parsed instead of the string containing the value. If you do not want this to happen, look at the `notParsed` query parameter below.
+This means the actual value will be parsed instead of the string containing the value. If you do not want this to happen, look at the [`notParsed` query parameter below](#notParsed).
 
 #### Examples
 1. Order by child parameter
 ```js
 firebaseConnect([
-  'todos#orderByChild=createdBy&equalTo=ASD123',
-  // { path: '/todos', queryParams: [ 'orderByChild=createdBy', 'equalTo=ASD123' ] } // object notation
+  { path: '/todos', queryParams: [ 'orderByChild=createdBy', 'equalTo=ASD123' ] }
+  // 'todos#orderByChild=createdBy&equalTo=ASD123', // string notation
 ])
 ```
 
-## notParsed
+## notParsed {#notParsed}
 
 Can be used to keep internal parsing from happening. Useful when attempting to search a number string using `equalTo`
 
@@ -363,23 +382,3 @@ compose(
   }))
 )
 ```
-
-## storeAs {#storeAs}
-
-By default the results of queries are stored in redux under the path of the query. If you would like to change where the query results are stored in redux, use `storeAs`:
-
-#### Examples
-1. Querying the same path with different query parameters
-
-```js
-compose(
-  firebaseConnect(props => [
-    { path: 'projects' }
-    { path: 'projects', storeAs: 'myProjects', queryParams: ['orderByChild=uid', '123'] }
-  ]),
-  connect(({ firebase }, props) => ({
-    projects: populatedDataToJS(firebase, 'projects'),
-    myProjects: populatedDataToJS(firebase, 'myProjects'), // use storeAs path to gather from redux
-  }))
-)
-```