diff --git a/lib/fs.js b/lib/fs.js index 34517a17dab484..a57e97d69ad889 100644 --- a/lib/fs.js +++ b/lib/fs.js @@ -1342,10 +1342,10 @@ function watch(filename, options, listener) { if (!watchers) watchers = require('internal/fs/watchers'); const watcher = new watchers.FSWatcher(); - watcher.start(filename, - options.persistent, - options.recursive, - options.encoding); + watcher[watchers.kFSWatchStart](filename, + options.persistent, + options.recursive, + options.encoding); if (listener) { watcher.addListener('change', listener); diff --git a/lib/internal/fs/watchers.js b/lib/internal/fs/watchers.js index bde07cfdc59d41..4dfa83c3b218e2 100644 --- a/lib/internal/fs/watchers.js +++ b/lib/internal/fs/watchers.js @@ -25,6 +25,8 @@ const assert = require('internal/assert'); const kOldStatus = Symbol('kOldStatus'); const kUseBigint = Symbol('kUseBigint'); +const kFSWatchStart = Symbol('kFSWatchStart'); + function emitStop(self) { self.emit('stop'); } @@ -135,18 +137,16 @@ function FSWatcher() { Object.setPrototypeOf(FSWatcher.prototype, EventEmitter.prototype); Object.setPrototypeOf(FSWatcher, EventEmitter); - -// FIXME(joyeecheung): this method is not documented. // At the moment if filename is undefined, we -// 1. Throw an Error if it's the first time .start() is called -// 2. Return silently if .start() has already been called +// 1. Throw an Error if it's the first time Symbol('kFSWatchStart') is called +// 2. Return silently if Symbol('kFSWatchStart') has already been called // on a valid filename and the wrap has been initialized // 3. Return silently if the watcher has already been closed // This method is a noop if the watcher has already been started. -FSWatcher.prototype.start = function(filename, - persistent, - recursive, - encoding) { +FSWatcher.prototype[kFSWatchStart] = function(filename, + persistent, + recursive, + encoding) { if (this._handle === null) { // closed return; } @@ -202,5 +202,6 @@ Object.defineProperty(FSEvent.prototype, 'owner', { module.exports = { FSWatcher, - StatWatcher + StatWatcher, + kFSWatchStart }; diff --git a/test/parallel/test-fs-watch.js b/test/parallel/test-fs-watch.js index e596f32a766926..fb674bbfeab4c5 100644 --- a/test/parallel/test-fs-watch.js +++ b/test/parallel/test-fs-watch.js @@ -57,8 +57,6 @@ for (const testCase of cases) { }); watcher.on('close', common.mustCall(() => { watcher.close(); // Closing a closed watcher should be a noop - // Starting a closed watcher should be a noop - watcher.start(); })); watcher.on('change', common.mustCall(function(eventType, argFilename) { if (interval) { @@ -71,16 +69,11 @@ for (const testCase of cases) { assert.strictEqual(eventType, 'change'); assert.strictEqual(argFilename, testCase.fileName); - // Starting a started watcher should be a noop - watcher.start(); - watcher.start(pathToWatch); - watcher.close(); // We document that watchers cannot be used anymore when it's closed, // here we turn the methods into noops instead of throwing watcher.close(); // Closing a closed watcher should be a noop - watcher.start(); // Starting a closed watcher should be a noop })); // Long content so it's actually flushed. toUpperCase so there's real change.