Fix some examples and docs + using https everywhere #436
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
hzalaz
suggested changes
May 17, 2017
package.json
Outdated
| @@ -22,7 +22,7 @@ | |||
| "test:watch": "mocha --watch -R min test/**/*.test.js", | |||
| "ci:test": "istanbul cover _mocha --report lcovonly -R test/**/* -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-", | |||
| "ci:coverage": "codecov", | |||
| "lint": "eslint ./src", | |||
| "lint": "eslint --fix ./src", | |||
src/web-auth/index.js
Outdated
| * @param {String} options.password user password | ||
| * @param {String} options.realm realm | ||
| * @param {Function} cb callback function called only when an authorization error occurs. Has the error as the only parameter. | ||
| * @param {String} [options.username] Username |
There was a problem hiding this comment.
Explain that username and email are mutually exclusive here too
There was a problem hiding this comment.
And if both are supplied explain what happens if you don't raise an error
src/web-auth/index.js
Outdated
| * @param {String} [options.username] Username | ||
| * @param {String} [options.email] Email | ||
| * @param {String} options.password Password | ||
| * @param {String} [options.realm] Use the realm paramater to specify a connection. Ex: 'Username-Password-Authentication' |
There was a problem hiding this comment.
realm used to authenticate the user, it can be a realm name or a database connection name
src/web-auth/index.js
Outdated
| * @param {String} [options.email] Email | ||
| * @param {String} options.password Password | ||
| * @param {String} [options.realm] Use the realm paramater to specify a connection. Ex: 'Username-Password-Authentication' | ||
| * @param {Function} cb Callback function called only when an authorization error occurs. Has the error as the only parameter |
There was a problem hiding this comment.
Define the callback type as I did in the rest of jsdocs
hzalaz
previously approved these changes
May 17, 2017
hzalaz
previously approved these changes
May 17, 2017
hzalaz
previously approved these changes
May 17, 2017
hzalaz
approved these changes
May 17, 2017
luisrudge
changed the title
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.