Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document DirectoryChangeEvent #98

Open
cowwoc opened this issue Sep 29, 2024 · 1 comment
Open

Document DirectoryChangeEvent #98

cowwoc opened this issue Sep 29, 2024 · 1 comment

Comments

@cowwoc
Copy link

cowwoc commented Sep 29, 2024

Please document all the methods. For example, what is the difference between path() and rootPath()?

@gmethvin
Copy link
Owner

gmethvin commented Oct 3, 2024

Sure, I can do this when I get a chance or happy to accept your pull request.

To answer your question, rootPath is the root path that you've registered when creating the DirectoryWatcher, so one of the directories you pass to .path(dir) or .paths(dirs) in the builder. If you're only registering one root then you don't really need this information, but it may be useful if you have multiple watchers or multiple paths registered with the same DirectoryWatcher instance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants