Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

replace-homedir

1.0.0 • Public • Published

replace-homedir

NPM version Downloads Build Status AppVeyor Build Status Coveralls Status Gitter chat

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

install

npm i replace-homedir

Downloadsweekly downloads

115,547

version

1.0.0

license

MIT

repository

githubgithub

last publish

collaborators

  • avatar