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.

Sign up for GitHub

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

doc: add missing URL argument types in fs.md #18309

Closed
wants to merge 1 commit into from
Closed

doc: add missing URL argument types in fs.md #18309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,7 @@ changes:
description: The `file` parameter can be a file descriptor now.
-->

* `file` {string|Buffer|number} filename or file descriptor
* `file` {string|Buffer|URL|number} filename or file descriptor
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
Expand Down Expand Up @@ -898,7 +898,7 @@ changes:
description: The `file` parameter can be a file descriptor now.
-->

* `file` {string|Buffer|number} filename or file descriptor
* `file` {string|Buffer|URL|number} filename or file descriptor
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
Expand Down Expand Up @@ -1709,7 +1709,7 @@ changes:
it will emit a deprecation warning.
-->

* `path` {string|Buffer}
* `path` {string|Buffer|URL}
* `mode` {integer}
* `callback` {Function}
* `err` {Error}
Expand All @@ -1724,7 +1724,7 @@ Only available on macOS.
deprecated: v0.4.7
-->

* `path` {string|Buffer}
* `path` {string|Buffer|URL}
* `mode` {integer}

Synchronous lchmod(2). Returns `undefined`.
Expand All @@ -1739,7 +1739,7 @@ changes:
it will emit a deprecation warning.
-->

* `path` {string|Buffer}
* `path` {string|Buffer|URL}
* `uid` {integer}
* `gid` {integer}
* `callback` {Function}
Expand All @@ -1753,7 +1753,7 @@ to the completion callback.
deprecated: v0.4.7
-->

* `path` {string|Buffer}
* `path` {string|Buffer|URL}
* `uid` {integer}
* `gid` {integer}

Expand Down Expand Up @@ -2694,7 +2694,7 @@ changes:
it will emit a deprecation warning.
-->

* `path` {string|Buffer}
* `path` {string|Buffer|URL}
* `len` {integer} **Default:** `0`
* `callback` {Function}
* `err` {Error}
Expand All @@ -2711,7 +2711,7 @@ being thrown in the future.
added: v0.8.6
-->

* `path` {string|Buffer}
* `path` {string|Buffer|URL}
* `len` {integer} **Default:** `0`

Synchronous truncate(2). Returns `undefined`. A file descriptor can also be
Expand Down Expand Up @@ -2760,7 +2760,7 @@ Synchronous unlink(2). Returns `undefined`.
added: v0.1.31
-->

* `filename` {string|Buffer}
* `filename` {string|Buffer|URL}
* `listener` {Function} Optional, a listener previously attached using
`fs.watchFile()`

Expand Down Expand Up @@ -3120,7 +3120,7 @@ changes:
description: The `file` parameter can be a file descriptor now.
-->

* `file` {string|Buffer|integer} filename or file descriptor
* `file` {string|Buffer|URL|integer} filename or file descriptor
* `data` {string|Buffer|Uint8Array}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
Expand Down Expand Up @@ -3171,7 +3171,7 @@ changes:
description: The `file` parameter can be a file descriptor now.
-->

* `file` {string|Buffer|integer} filename or file descriptor
* `file` {string|Buffer|URL|integer} filename or file descriptor
* `data` {string|Buffer|Uint8Array}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
Expand Down