Clean up AsyncProgressWorker documentation #831
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
The old documentation was not very clear on how to use the API. It was missing javascript references, and was not necessarily following the best coding standards. These adjustments make it a bit more complete now by providing all three necessary parts, the worker, the hookup code, and the javascript usage of it. I have also gone ahead and rewritten the `AsyncProgressQueueWorker` example to show demonstration of the `FunctionReference` class and how to use multiple callbacks instead of one combined callback.
NickNaso
reviewed
Nov 6, 2020
NickNaso
reviewed
Nov 7, 2020
doc/async_worker_variants.md
Outdated
| @@ -550,7 +550,7 @@ const onProgressCallback = (num) => { | |||
| // ... | |||
| }; | |||
|
|
|||
| // Call our native addon with the paramters of a string and a function | |||
| // Call our native addon with the paramters of a string three callback functions | |||
There was a problem hiding this comment.
Maybe it shlould be:
of a string and three callback functions
There was a problem hiding this comment.
This is why I should not adjust my code late at night :( Fixing it
Superlokkus
pushed a commit
to Superlokkus/node-addon-api
that referenced
this pull request
Nov 20, 2020
* Clean up AsyncProgressWorker documentation The old documentation was not very clear on how to use the API. It was missing javascript references, and was not necessarily following the best coding standards. These adjustments make it a bit more complete now by providing all three necessary parts, the worker, the hookup code, and the javascript usage of it. I have also gone ahead and rewritten the `AsyncProgressQueueWorker` example to show demonstration of the `FunctionReference` class and how to use multiple callbacks instead of one combined callback.
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.
The old documentation was not very clear on how to use the API. It was missing javascript references, and was not necessarily following the best coding standards.
These adjustments make it a bit more complete now by providing all three necessary parts, the worker, the hookup code, and the javascript usage of it.
I have also gone ahead and rewritten the
AsyncProgressQueueWorkerexample to show demonstration of theFunctionReferenceclass and how to use multiple callbacks instead of one combined callback.