diff options
Diffstat (limited to 'node_modules/fs-extra/docs/ensureSymlink-sync.md')
-rw-r--r-- | node_modules/fs-extra/docs/ensureSymlink-sync.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/ensureSymlink-sync.md b/node_modules/fs-extra/docs/ensureSymlink-sync.md new file mode 100644 index 0000000..328d4c4 --- /dev/null +++ b/node_modules/fs-extra/docs/ensureSymlink-sync.md @@ -0,0 +1,18 @@ +# ensureSymlinkSync(srcpath, dstpath, [type]) + +Ensures that the symlink exists. If the directory structure does not exist, it is created. + +- `srcpath` `<String>` +- `dstpath` `<String>` +- `type` `<String>` + +## Example: + +```js +const fs = require('fs-extra') + +const srcpath = '/tmp/file.txt' +const dstpath = '/tmp/this/path/does/not/exist/file.txt' +fs.ensureSymlinkSync(srcpath, dstpath) +// symlink has now been created, including the directory it is to be placed in +``` |