node-fs-extra/docs/ensureLink-sync.md
Mani Maghsoudlou b0eb751a75
Improve docs (#795)
* improve docs

* Update docs/ensureSymlink-sync.md

Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>

* Update docs/ensureSymlink.md

Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>

* add Error type to docs

Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>
2020-05-11 16:40:39 -04:00

463 B

ensureLinkSync(srcPath, destPath)

Ensures that the link exists. If the directory structure does not exist, it is created.

Alias: createLinkSync()

  • srcPath <String>
  • destPath <String>

Example:

const fs = require('fs-extra')

const srcPath = '/tmp/file.txt'
const destPath = '/tmp/this/path/does/not/exist/file.txt'
fs.ensureLinkSync(srcPath, destPath)
// link has now been created, including the directory it is to be placed in