executable

Check if a file is executable

Install

npm install @xhmikosr/executable

Usage

import executable from '@xhmikosr/executable';

executable('bash').then(exec => {
	console.log(exec);
	//=> true
});

API

executable(file)

Returns a Promise for a boolean.

executable.sync(file)

Returns a boolean of whether the file is executable.

file

Type: string

Path of the file.

executable.checkMode(mode, [gid], [uid])

Returns a boolean of whether the mode passed as first argument means that the file is executable.

mode

Type: number

Property mode of fs.Stats instance returned by fs.stat() (or fs.statSync()) function.

gid, uid

Type: number

Respectively the group identity and user identity of the file. If not set, permissions will be evaluated without considering owner or group of the file.

Related

• executable-cli - CLI for this module

License

MIT © Kevin Mårtensson