Skip to content

Commit

Permalink
doc: add WHATWG file URLs in fs module
Browse files Browse the repository at this point in the history
Update fs module documentation adding WHATWG file URLS support for
relevant fs functions/classes.

Fixes: nodejs#12341
Refs: nodejs#10739
  • Loading branch information
Olivier Martin committed May 6, 2017
1 parent b2257f9 commit eddf10c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,10 +213,15 @@ The object itself emits these events:
### Event: 'change'
<!-- YAML
added: v0.5.8
changes:
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `filename` parameter can be a WHATWG `URL` object using
`file:` protocol. Support is currently still *experimental*.
-->

* `eventType` {string} The type of fs change
* `filename` {string|Buffer} The filename that changed (if relevant/available)
* `filename` {string|Buffer|URL} The filename that changed (if relevant/available)

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

0 comments on commit eddf10c

Please sign in to comment.