@ronomon/opened

Check if a file is open in another application on Windows, macOS and Linux.

Stats

StarsIssuesVersionUpdatedCreatedSize
@ronomon/opened
801.5.26 months ago4 years agoMinified + gzip package size for @ronomon/opened in KB

Readme

opened

Check if a file is open in another application on Windows, macOS and Linux. Linux requires privileges.

Installation

npm install @ronomon/opened

Windows

Opened uses a native binding on Windows to try and open an existing file with exclusive sharing mode (dwShareMode) and detect an ERROR_SHARING_VIOLATION error if another application already has an open handle to the file. This will detect any applications with open handles to the file, but not applications which have opened, buffered the file for display, and then closed the handle (i.e. applications which may be showing the file to the user, but which no longer have an open handle to the file).

Unix

Opened uses lsof on macOS and on Linux. On Linux (but not on macOS), lsof requires sudo permissions to iterate across open file descriptors for the user, otherwise no files will be detected as open and no permissions error will be returned.

Usage

var Opened = require('@ronomon/opened');
var paths = [...];
Opened.files(paths,
  function(error, hashTable) {
    if (error) throw error;
    paths.forEach(
      function(path) {
        console.log(path + ' open=' + hashTable[path]);
      }
    );
  }
);

Tests

node test.js

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.