Add documentation for [JS-SDK] ParseQuery.withCount #644
Conversation
|
Can you add a disclaimer? Count operations can be slow and expensive. |
|
Looks good, I’ll add this to the PHP SDK as well. |
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
| @@ -57,6 +57,27 @@ You can skip the first results by setting `skip`. In the old Parse hosted backen | |||
| query.skip(10); // skip the first 10 results | |||
| ``` | |||
|
|
|||
| If you want to know the total number of rows in a table satisfying your query, for e.g. pagination purposes - you can use `withCount` (`false` by default). | |||
|
|
|||
| **Note:** Enabling this flag will change the structure of response, see the example below. | |||
There was a problem hiding this comment.
I thought it was true by default? You can just use query.withCount() no?
There was a problem hiding this comment.
If you want to know the total number of rows in a table satisfying your query, for e.g. pagination purposes - you can use withCount() (optionally accepts a boolean, defaults to true when called without arguments or undefined).
Will this be more clear?
There was a problem hiding this comment.
(optionally accepts a boolean, defaults to true) should be fine
There was a problem hiding this comment.
can't this be mis-interpreted like it's an always enabled by default on every query?
There was a problem hiding this comment.
I agree with @dplewis, it's referencing that particular method not querying in general
There was a problem hiding this comment.
Alternatively, you could not mention the optional boolean as its not strictly relevant to this explanation.
There was a problem hiding this comment.
right, jsdoc will show these details anyway when it comes to coding
There was a problem hiding this comment.
@dplewis are you happy with that change?
|
Thanks for contributing! I added this to the PHP SDK too. |
|
|
|
Nice catch! I can take a look at it. |
See:
parse-community/Parse-SDK-JS#865
parse-community/Parse-SDK-JS#868