jorge a7910c81a8 | ||
---|---|---|
.. | ||
LICENSE | ||
README.md | ||
index.js | ||
package.json |
README.md
replace-homedir
Replace user home in a string with another string. Useful for tildifying a path.
Usage
var replaceHomedir = require('replace-homedir');
var shortPath = replaceHomedir('/Users/phated/myProject', '~');
// shortPath === '~/myProject'
API
replaceHomedir(path, replacement)
Takes a string path
as the first argument and a string or function replacement
as the second argument. If the path
is absolute and begins with the User's homedir, the homedir portion of the path is replaced with replacement
using String#replace.
If path
is not a string, the function will throw.
License
MIT