Wrapper for access() UNIX C function
Node.js module wrapping
access() UNIX C function, which is currently missing in both V8 and Node's fs API. Both
async implementations are available.
OS X and
Linux platforms supported.
Ever needed to find out whether your app has specific permissions to a path? Now you can check a path for
execute/search permissions on files and directories.
For more information about UNIX
access() function, run
man access in your OS.
require('unix-access') and you can run two functions available:
var access = require'unix-access';var result;// synchronous checksresult = accesssync'/var/log/your_app.log' ''; // existence of the fileresult = accesssync'/var/log/your_app.log' 'rw'; // read and write permissionsresult = accesssync'/var/log/your_app_dir/' 'rwx'; // full control// asynchronous check for read and executable permissionsaccessasync'/bin/tar' 'rx'console.logresult;;
Both arguments are of
String type. Return value is of
Boolean type. TypeError exception is thrown in case of incorrect type of aguments.
Permissions may contain case-insensitive combination of
x characters. Any other characters will be stripped out.
True return value indicates you do have the permissions you were testing the path for,
False means you do not.
Works the same way as
sync version but asychronously. Callback argument must be of
Two arguments will be passed over the
callback(err, result) function. Err is of
String type, result of
npm install unix-access
Tested on OS X Mavericks 10.9.
- Command Line Tools installed either separately or via Xcode
- Python 2.7 (present in the OS by default)
Tested on Debian Wheezy 7.0.
- Python 2.7
This module does not depend on any other Node.js module. For developers of this tool,
should are the only dependencies for running unit tests.
npm install unix-access, npm copies the module into node_modules directory and then executes
node-gyp rebuild command to compile C++ sources.
node-gyp is bundled within npm itself so you don't need to install it separately.
The C++ code being built by
node-gyp is a gue between Google's V8 engine and native OS access() call defined in
Async function is really asynchronous (NOT just issuing callback in
uv_queue_work() call from
libuv manages the asynchronous execution in a separate thread pool.
In order to develop this module, these steps are required:
- Clone the git repo by executing
git clone URL
- Go to the newly created directory in Terminal
npm install node-gyp -g
npm installto download dependencies
node-gyp rebuildto build your modified code
- Run unit tests by
If you want to develop this module and try to install
dev_dependencies by executing
npm install, you may see the error message below:
npm WARN cannot run in wd firstname.lastname@example.org node-gyp rebuild (wd=/root/unix-access-master)
The reason why
npm install fails is that you run the
npm install command as
root user. If you really have to work under root user, use
npm install --unsafe-perm instead.