Skip to content

doc: clarify fs.link and fs.linkSync arguments #9145

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

Closed
kemitchell wants to merge 2 commits into from
Closed

doc: clarify fs.link and fs.linkSync arguments #9145

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5618ae2
doc: clarify fs.link and fs.linkSync arguments
kemitchell Oct 18, 2016
ecacc61
fs: clarify fs.link and fs.linkSync arguments
kemitchell Oct 19, 2016
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
Next Next commit
doc: clarify fs.link and fs.linkSync arguments 
Clarifies documentation by replacing the argument names `srcpath`
and `dstpath` with more descriptive `existingPath` and `newPath`,
reflecting how POSIX describes `link()`.
  • Loading branch information
@kemitchell
kemitchell committed Oct 19, 2016
commit 5618ae2f0364d602f816b2c290742a9dd4ecab99
12 changes: 6 additions & 6 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1034,25 +1034,25 @@ deprecated: v0.4.7

Synchronous lchown(2). Returns `undefined`.

## fs.link(srcpath, dstpath, callback)
## fs.link(existingPath, newPath, callback)
<!-- YAML
added: v0.1.31
-->

* `srcpath` {String | Buffer}
* `dstpath` {String | Buffer}
* `existingPath` {String | Buffer}
* `newPath` {String | Buffer}
* `callback` {Function}

Asynchronous link(2). No arguments other than a possible exception are given to
the completion callback.

## fs.linkSync(srcpath, dstpath)
## fs.linkSync(existingPath, newPath)
<!-- YAML
added: v0.1.31
-->

* `srcpath` {String | Buffer}
* `dstpath` {String | Buffer}
* `existingPath` {String | Buffer}
* `newPath` {String | Buffer}

Synchronous link(2). Returns `undefined`.

Expand Down