studio-variable/nouveau-theatre-de-besancon
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
nouveau-theatre-de-besancon/node_modules/replace-homedir
History
isUnknown b6a3900ee2 install gulp to process code
2024-09-20 10:32:49 +02:00
..
index.js install gulp to process code 2024-09-20 10:32:49 +02:00
LICENSE install gulp to process code 2024-09-20 10:32:49 +02:00
package.json install gulp to process code 2024-09-20 10:32:49 +02:00
README.md install gulp to process code 2024-09-20 10:32:49 +02:00

README.md

replace-homedir

NPM version Downloads Build Status Coveralls Status

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