Neolithic Programming Machine
    Wondering what’s next for npm?Check out our public roadmap! »

    homedir-polyfill

    1.0.3 • Public • Published

    homedir-polyfill NPM version NPM monthly downloads NPM total downloads Linux Build Status Windows Build Status

    Node.js os.homedir polyfill for older versions of node.js.

    Please consider following this project's author, Brian Woodward, and consider starring the project to show your ❤️ and support.

    Install

    Install with npm:

    $ npm install --save homedir-polyfill

    Usage

    var homedir = require('homedir-polyfill');
    console.log(homedir());
    //=> /Users/doowb

    Reasoning

    This library is a polyfill for the node.js os.homedir method found in modern versions of node.js.

    This implementation tries to follow the implementation found in libuv by finding the current user using the process.geteuid() method and the /etc/passwd file. This should usually work in a linux environment, but will also fallback to looking at user specific environment variables to build the user's home directory if neccessary.

    Since /etc/passwd is not available on windows platforms, this implementation will use environment variables to find the home directory.

    In modern versions of node.js, os.homedir is used.

    About

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

    Running Tests

    Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

    $ npm install && npm test
    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Related projects

    You might also be interested in these projects:

    parse-passwd: Parse a passwd file into a list of users. | homepage

    Contributors

    Commits Contributor
    19 doowb
    2 martinheidegger

    Author

    Brian Woodward

    License

    Copyright © 2016 - 2019, Brian Woodward. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.8.0, on February 21, 2019.

    Install

    npm i homedir-polyfill

    DownloadsWeekly Downloads

    7,294,846

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    8.05 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar