home-path
Advanced tools
Comparing version 1.0.6 to 1.0.7
61
index.js
'use strict' | ||
var os = require('os') | ||
/** | ||
* Cross-platform home directory retriever, tested on Windows XP and above, Mac OSX and Linux. | ||
* | ||
* With node versions 2.3.0 (iojs) or higher, the built-in [`os.homedir`](https://nodejs.org/api/os.html#os_os_homedir) method is used. | ||
* | ||
* @module home-path | ||
* @example | ||
* var getHomePath = require('home-path') | ||
*/ | ||
module.exports = os.homedir ? os.homedir : getHomePath | ||
* Cross-platform home directory retriever, tested on Windows XP and above, Mac OSX and Linux. | ||
* | ||
* With node versions 2.3.0 (iojs) or higher, the built-in [`os.homedir`](https://nodejs.org/api/os.html#os_os_homedir) method is used. | ||
* | ||
* @module home-path | ||
* @example | ||
* var getHomePath = require('home-path') | ||
*/ | ||
/** | ||
* @alias module:home-path | ||
* @example | ||
* Mac OSX | ||
* ```js | ||
* > getHomePath() | ||
* '/Users/Lloyd' | ||
* ``` | ||
* | ||
* Ubuntu Linux | ||
* ```js | ||
* > getHomePath() | ||
* '/home/lloyd' | ||
* ``` | ||
* | ||
* Windows 8.1 | ||
* ```js | ||
* > getHomePath() | ||
* 'C:\\Users\\Lloyd' | ||
* ``` | ||
*/ | ||
* @alias module:home-path | ||
* @example | ||
* Mac OSX | ||
* ```js | ||
* > getHomePath() | ||
* '/Users/Lloyd' | ||
* ``` | ||
* | ||
* Ubuntu Linux | ||
* ```js | ||
* > getHomePath() | ||
* '/home/lloyd' | ||
* ``` | ||
* | ||
* Windows 8.1 | ||
* ```js | ||
* > getHomePath() | ||
* 'C:\\Users\\Lloyd' | ||
* ``` | ||
*/ | ||
function getHomePath () { | ||
@@ -43,1 +41,4 @@ if (process.platform === 'win32') { | ||
} | ||
var os = require('os') | ||
module.exports = os.homedir ? os.homedir : getHomePath |
{ | ||
"name": "home-path", | ||
"author": "Lloyd Brookes <75pound@gmail.com>", | ||
"version": "1.0.6", | ||
"version": "1.0.7", | ||
"description": "Cross-platform home directory retriever", | ||
"repository": "https://github.com/75lb/home-path.git", | ||
"repository": "https://github.com/75lb/home-path", | ||
"license": "MIT", | ||
@@ -19,5 +19,8 @@ "keywords": [ | ||
"devDependencies": { | ||
"jsdoc-to-markdown": "^4.0.1", | ||
"tape": "^4.9" | ||
} | ||
"jsdoc-to-markdown": "^5.0.1", | ||
"tape": "^4.11" | ||
}, | ||
"files": [ | ||
"index.js" | ||
] | ||
} |
[![view on npm](http://img.shields.io/npm/v/home-path.svg)](https://www.npmjs.org/package/home-path) | ||
[![npm module downloads](http://img.shields.io/npm/dt/home-path.svg)](https://www.npmjs.org/package/home-path) | ||
[![Build Status](https://travis-ci.org/75lb/home-path.svg?branch=master)](https://travis-ci.org/75lb/home-path) | ||
[![Dependency Status](https://david-dm.org/75lb/home-path.svg)](https://david-dm.org/75lb/home-path) | ||
[![Dependency Status](https://badgen.net/david/dep/75lb/home-path)](https://david-dm.org/75lb/home-path) | ||
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard) | ||
@@ -43,2 +43,2 @@ | ||
© 2015-18 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). | ||
© 2015-19 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
4556
5
40