This repository was archived by the owner on Mar 11, 2022. It is now read-only.
Add 'Callback Signature' section to README. #305
Merged
Conversation
This file contains hidden or 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
ricellis
approved these changes
Apr 27, 2018
|
|
||
| After initialization, in general, callback functions receive three arguments: | ||
| ### Callback Signature | ||
|
|
Member
There was a problem hiding this comment.
I know it is in the examples later anyway, but I think it would be nice to have the function signature here too
function(err, body, headers) {}just so people can actually see the signature before the description of the parameters
README.md
Outdated
| [ '_replicator', '_users' ] | ||
| ``` | ||
|
|
||
| * `header` - The HTTP _response header_ (if no error). For example: |
Member
There was a problem hiding this comment.
It seems weird that we call this header and not headers since it is all the response headers. Even if they are in a single object. WDYT?
Contributor
Author
There was a problem hiding this comment.
Yeah, agreed. I'll update all the instances in the README.
smithsz
force-pushed
the
303-document-error
branch
from
6969032 to
a11cee6
Compare
smithsz
force-pushed
the
303-document-error
branch
from
a11cee6 to
65832ab
Compare
tomblench
approved these changes
Apr 30, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Thanks for your hard work, please ensure all items are complete before opening.
What
Add 'Callback Signature' section to README.
Issues
Fixes #303.