aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/ensureSymlink.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/ensureSymlink.md')
-rw-r--r--node_modules/fs-extra/docs/ensureSymlink.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/ensureSymlink.md b/node_modules/fs-extra/docs/ensureSymlink.md
new file mode 100644
index 0000000..45524f1
--- /dev/null
+++ b/node_modules/fs-extra/docs/ensureSymlink.md
@@ -0,0 +1,30 @@
+# ensureSymlink(srcpath, dstpath, [type, callback])
+
+Ensures that the symlink exists. If the directory structure does not exist, it is created.
+
+- `srcpath` `<String>`
+- `dstpath` `<String>`
+- `type` `<String>`
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const srcpath = '/tmp/file.txt'
+const dstpath = '/tmp/this/path/does/not/exist/file.txt'
+fs.ensureSymlink(srcpath, dstpath, err => {
+ console.log(err) // => null
+ // symlink has now been created, including the directory it is to be placed in
+})
+
+// With Promises:
+fs.ensureSymlink(srcpath, dstpath)
+.then(() => {
+ console.log('success!')
+})
+.catch(err => {
+ console.error(err)
+})
+```