umount

Umount a device in UNIX based operating systems

Usage no npm install needed!

<script type="module">
  import umount from 'https://cdn.skypack.dev/umount';
</script>

README

umount

npm version dependencies Build Status Build status

Unmount a device in UNIX, do nothing in Windows.

This module doesn't include native bindings, it constructs and runs the corresponding umount command with child_process.exec().

If the platform is win32, the umount function does nothing, and calls the given callback with (null, null, null). This allows the client to call this module independently of the operating system while getting the desired behaviour.

Installation

Install umount by running:

$ npm install --save umount

Documentation

umount.umount(String device, Function callback)

Unmount a device.

The callback gets three arguments: (error, stdout, stderr).

Example:

umount = require('umount') 

umount.umount '/dev/disk2', (error, stdout, stderr) ->
    throw error if error?
    console.log(stdout)

umount.isMounted(String device, Function callback)

Check if a device is mounted.

Note: This function always yields true in win32.

The callback gets two arguments: (error, isMounted).

Example:

umount = require('umount') 

umount.isMounted '/dev/disk2', (error, isMounted) ->
    throw error if error?
    console.log("Is Mounted? #{isMounted}")

Tests

Run the test suite by doing:

$ gulp test

Contribute

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ gulp lint

Support

If you're having any problem, please raise an issue on GitHub.

ChangeLog

v1.1.6

  • Update outdated dependencies.

v1.1.5

  • Escape device paths containing spaces.

v1.1.4

  • Pass force to diskutil unmountDisk in OS X.

v1.1.3

  • Call /usr/sbin/diskutil instead of just diskutil in OS X.

v1.1.2

  • Do not use sudo to unmount disks in OS X.

v1.1.1

  • Redirect Linux umount stderr output to /dev/null and ignore return code.

v1.1.0

  • Implement umount.isMounted() function.

v1.0.1

  • Fix improper unmounting of multiple partitions in GNU/Linux.

License

The project is licensed under the MIT license.