Skip to content

fs: add fsPromises.watch() - #37179

Closed
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:async-fs-watch
Closed

fs: add fsPromises.watch()#37179
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:async-fs-watch

Conversation

@jasnell

@jasnell jasnell commented Feb 2, 2021

Copy link
Copy Markdown
Member

An alternative to fs.watch() that returns an AsyncIterator

const { watch } = require('fs/promises');

(async () => {

  const ac = new AbortController();
  const { signal } = ac;
  setTimeout(() => ac.abort(), 10000);

  const watcher = watch('file.txt', { signal });

  for await (const { eventType, filename } of watcher) {
    console.log(eventType, filename);
  }

})()

Signed-off-by: James M Snell jasnell@gmail.com

@jasnell jasnell added fs Issues and PRs related to file-system APIs and the fs module. semver-minor PRs that contain new features and should be released in the next minor version. promises Issues and PRs related to ECMAScript promises. labels Feb 2, 2021
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread doc/api/fs.md Outdated
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread doc/api/fs.md Outdated
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread doc/api/fs.md Outdated
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread doc/api/fs.md Outdated
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread lib/internal/fs/watchers.js Outdated
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread lib/internal/fs/watchers.js Outdated
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread lib/internal/fs/watchers.js Outdated
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread lib/internal/fs/watchers.js Outdated
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes

@benjamingr benjamingr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good start and interesting API.

LMK if you'd like me to PR signal support for fs.watch or help otherwise.

aduh95
aduh95 reviewed Feb 2, 2021
View reviewed changes
Comment thread lib/internal/fs/watchers.js Outdated
Comment thread lib/internal/fs/watchers.js Outdated
@benjamingr benjamingr mentioned this pull request Feb 2, 2021
Closed
4 of 11 tasks
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@benjamingr benjamingr mentioned this pull request Feb 2, 2021
Closed
benjamingr
benjamingr reviewed Feb 2, 2021
View reviewed changes
Comment thread test/parallel/test-fs-promises-watch.js Outdated
benjamingr
benjamingr approved these changes Feb 2, 2021
View reviewed changes

ghost left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@nodejs-github-bot

This comment has been minimized.

Sign in to view
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@nodejs-github-bot

ghost commented Feb 2, 2021 •
edited by jasnell
Loading

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/35900/ 💚

@jasnell jasnell added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Feb 2, 2021
James M Snell added 2 commits February 15, 2021 06:59
James M Snell
fs: add fsPromises.watch()
d5f74c6 
An alternative to `fs.watch()` that returns an `AsyncIterator`

```js
const { watch } = require('fs/promises');

(async () => {

  const ac = new AbortController();
  const { signal } = ac;
  setTimeout(() => ac.abort(), 10000);

  const watcher = watch('file.txt', { signal });

  for await (const { eventType, filename } of watcher) {
    console.log(eventType, filename);
  }

})()
```

Signed-off-by: James M Snell <jasnell@gmail.com>
James M Snell
fixup! fs: add fsPromises.watch()
6e27a09
@nodejs-github-bot

ghost commented Feb 15, 2021 •
edited by jasnell
Loading

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/36138/ 💚

@jasnell

ghost commented Feb 15, 2021

Copy link
Copy Markdown
Member Author

Landed in 9803729

@jasnell jasnell closed this Feb 15, 2021
@jasnell jasnell added the notable-change PRs with changes that should be highlighted in changelogs. label Feb 15, 2021
This was referenced Feb 16, 2021
Closed
Merged
@azu azu mentioned this pull request Feb 18, 2021
Open
@targos targos mentioned this pull request Sep 4, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aduh95 aduh95 aduh95 left review comments
@benjamingr benjamingr benjamingr approved these changes

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. fs Issues and PRs related to file-system APIs and the fs module. notable-change PRs with changes that should be highlighted in changelogs. promises Issues and PRs related to ECMAScript promises. semver-minor PRs that contain new features and should be released in the next minor version.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jasnell @nodejs-github-bot @benjamingr @aduh95