Skip to content

Commit eddf10c

Browse files
author
Olivier Martin
committed
doc: add WHATWG file URLs in fs module
Update fs module documentation adding WHATWG file URLS support for relevant fs functions/classes. Fixes: nodejs#12341 Refs: nodejs#10739
1 parent b2257f9 commit eddf10c

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/api/fs.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,10 +213,15 @@ The object itself emits these events:
213213
### Event: 'change'
214214
<!-- YAML
215215
added: v0.5.8
216+
changes:
217+
- version: v7.6.0
218+
pr-url: https://github.com/nodejs/node/pull/10739
219+
description: The `filename` parameter can be a WHATWG `URL` object using
220+
`file:` protocol. Support is currently still *experimental*.
216221
-->
217222

218223
* `eventType` {string} The type of fs change
219-
* `filename` {string|Buffer} The filename that changed (if relevant/available)
224+
* `filename` {string|Buffer|URL} The filename that changed (if relevant/available)
220225

221226
Emitted when something changes in a watched directory or file.
222227
See more details in [`fs.watch()`][].

0 commit comments

Comments
 (0)