Adding pagination docs for clients/connections #268
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshcanhelp
suggested changes
May 29, 2018
src/management/ClientsManager.js
Outdated
| * </caption> | ||
| * | ||
| * // Pagination settings. | ||
| * var params = { |
There was a problem hiding this comment.
I would include what the defaults are, i.e. what happens if these are not passed (page 1, 50 per page I believe)
There was a problem hiding this comment.
I won't add that because it's a backend default and might change
src/management/ClientsManager.js
Outdated
| * management.clients.getAll(function (err, clients) { | ||
| * console.log(clients.length); | ||
| * }); | ||
| * | ||
| * @param {Function} [cb] Callback function. | ||
| * @param {Object} [params] Users params. |
src/management/ConnectionsManager.js
Outdated
| * management.connections.getAll(function (err, connections) { | ||
| * console.log(connections.length); | ||
| * }); | ||
| * | ||
| * @param {Function} [cb] Callback function. | ||
| * @param {Object} [params] Users params. |
src/management/ConnectionsManager.js
Outdated
| * </caption> | ||
| * | ||
| * // Pagination settings. | ||
| * var params = { |
There was a problem hiding this comment.
Same comment here, show what the defaults are if this is not provided
src/management/ClientsManager.js
Outdated
| * @example | ||
| * @example <caption> | ||
| * This method takes an optional object as first argument that may be used to | ||
| * specify pagination settings and the search query. |
src/management/ConnectionsManager.js
Outdated
| * @example | ||
| * @example <caption> | ||
| * This method takes an optional object as first argument that may be used to | ||
| * specify pagination settings and the search query. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.