Package Exports

fd-lock

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fd-lock) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

fd-lock

Advisory cross-platform lock on a file using a file descriptor to it.

npm install fd-lock

Usage

const lock = require('fd-lock')

// Can we lock the file using the fd?
console.log(lock(fd))

API

`bool = lock(fd)`

Try to lock access to a file using a file descriptor. Returns true if the file could be locked, false if not.

Note that the lock is only advisory and there is nothing stopping someone from accessing the file by simply ignoring the lock.

Works across processes as well.

`bool = lock.unlock(fd)`

Unlocks a file if you have the lock.

License

MIT