Fixes #10: Render progress bar programmatically. #13
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
Users can pass `renderProgressBar: true` to render the progress bar from an external tool. Additionally, they can provide `progressBarString: SOME_STRING` to modify the output format of the progress bar. This string must meet the format specified in http://npm.im/progress
|
Thinking twice about this, I think we should just move all the output logic from the main Something like: const autocannon = require('autocannon')
const instance = autocannon({ url: 'http://localhost:3000' }, done)
// customize your autocannon instance here
autocannon.track(instance, process.stdout)Does it make sense? That do you think? |
|
That sounds okay, I will update my PR to reflect this :) |
| * `progressBarString`: A `string` defining the format of the progress display output. Must be valid input for the [progress bar module](http://npm.im/progress). | ||
|
|
||
| **Returns** an instance/event emitter for tracking progress, etc. | ||
|
|
There was a problem hiding this comment.
We should probably list the events of this instance.
There was a problem hiding this comment.
I would like to merge both of my open PR's and then do docs on the events emitted by the instance, as the 'response' event needs to be explained, and the client object which it passes to the cb: https://github.com/mcollina/autocannon/pull/14/files#diff-de78b50723ff596d7bd35665f36a6cbfR60
|
This one is good to go then :). |
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.
Users can pass
renderProgressBar: trueto render theprogress bar from an external tool. Additionally, they
can provide
progressBarString: SOME_STRINGto modifythe output format of the progress bar. This string must
meet the format specified in npm.im/progress
This will require a review.
Additionally... how should I test this?