Browse Source

doc: fs: clarify fs.symlink Windows specific args

v0.10.22-release
Phillip Alexander 11 years ago
committed by Ben Noordhuis
parent
commit
977c54adb5
  1. 4
      doc/api/fs.markdown

4
doc/api/fs.markdown

@ -197,8 +197,8 @@ Synchronous link(2).
Asynchronous symlink(2). No arguments other than a possible exception are given
to the completion callback.
`type` argument can be either `'dir'`, `'file'`, or `'junction'` (default is `'file'`). It is only
used on Windows (ignored on other platforms).
The `type` argument can be set to `'dir'`, `'file'`, or `'junction'` (default
is `'file'`) and is only available on Windows (ignored on other platforms).
Note that Windows junction points require the destination path to be absolute. When using
`'junction'`, the `destination` argument will automatically be normalized to absolute path.

Loading…
Cancel
Save