Improve API and doc and add complete working example with node.js #28
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.
This PR should improve the documentation around the OAuth usage of the library.
It also adds an export of the library for nodejs as well as a complete example of how to use the library for an OAuth client with nodejs.
By implementing this example client I made a change in the defined API so that the
onRegistered
callback is now expected to return a Promise of the URL that the client should request containing the code and state. See the example for more details.Also, the
oauthFlow
method should hopefully be a little simpler, and the options of OAuth passed to the constructor or init method are now in a separate object field namedoauth
.