add explanation of chokidar's resource consumption#126
Open
fotoflo wants to merge 1 commit intoQard:masterfrom
Open
add explanation of chokidar's resource consumption#126fotoflo wants to merge 1 commit intoQard:masterfrom
fotoflo wants to merge 1 commit intoQard:masterfrom
Conversation
Collaborator
|
Can you move this to the end of the README? I don't think people need this information as the primary concern. Most likely how to use it is more of a concern. Also, if you're trying to quote things you can use block quotes in markdown to make that clearer. I'd also copy it over with the same formatting. The code blocks have been removed. Or just link to it instead of copying at all. |
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
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.
What: Add explanation of resource consumption to readme.md
Why: This is likely a primary concern of all developers. Certainly I wanted to know how it worked and what resources it would consume before adding it to my project.
Detail:
Resource Consumption
onchange is based on chokidar a "Minimal and efficient cross-platform file watching library"
"On MacOS, chokidar by default uses a native extension exposing the Darwin FSEvents API. This provides very efficient recursive watching compared with implementations like kqueue available on most *nix platforms. Chokidar still does have to do some work to normalize the events received that way as well."
"On most other platforms, the fs.watch-based implementation is the default, which avoids polling and keeps CPU usage down. Be advised that chokidar will initiate watchers recursively for everything within scope of the paths that have been specified, so be judicious about not wasting system resources by watching much more than needed."