1- mountutils
2- ==========
1+ # mountutils
32
43[ ![ npm] ( https://img.shields.io/npm/v/mountutils.svg?style=flat-square )] ( https://npmjs.com/package/mountutils )
54[ ![ npm license] ( https://img.shields.io/npm/l/mountutils.svg?style=flat-square )] ( https://npmjs.com/package/mountutils )
65[ ![ npm downloads] ( https://img.shields.io/npm/dm/mountutils.svg?style=flat-square )] ( https://npmjs.com/package/mountutils )
7- [ ![ Travis CI status] ( https://img.shields.io/travis/resin-io-modules/mountutils/master.svg?style=flat-square&label=linux%20|%20mac )] ( https://travis-ci.org/resin-io-modules/mountutils/branches )
8- [ ![ AppVeyor status] ( https://img.shields.io/appveyor/ci/resin-io/mountutils/master.svg?style=flat-square&label=windows )] ( https://ci.appveyor.com/project/resin-io/mountutils/branch/master )
96
107> Cross platform mount related utilities
118
12- Installation
13- ------------
9+ ## Installation
1410
1511Install ` mountutils ` by running:
1612
1713``` sh
1814$ npm install --save mountutils
1915```
2016
21- Debug mode
22- ----------
17+ ## Prebuild
18+
19+ This project contains cross-platform prebuild for node 18.18.2 and 20.5.1.
20+
21+ ## Debug mode
2322
2423You can enable debug mode by setting the ` MOUNTUTILS_DEBUG ` environment
2524variable.
2625
27- Documentation
28- -------------
26+ ## Documentation
2927
3028<a name =" module_mountutils.unmountDisk " ></a >
3129
3230### mountutils.unmountDisk(device, callback)
31+
3332** Kind** : static method of <code >[ mountutils] ( #module_mountutils ) </code >
3433** Summary** : Unmount a whole disk
35- ** Access** : public
34+ ** Access** : public
3635
37- | Param | Type | Description |
38- | --- | --- | --- |
39- | device | <code >String</code > | device |
36+ | Param | Type | Description |
37+ | -------- | --------------------- | ------------- --- |
38+ | device | <code >String</code > | device |
4039| callback | <code >function</code > | callback (error) |
4140
42- ** Example**
41+ ** Example**
42+
4343``` js
4444// macOS
45- const drive = ' /dev/disk2' ;
45+ const drive = " /dev/disk2" ;
4646
4747// GNU/Linux
48- const drive = ' /dev/sdb' ;
48+ const drive = " /dev/sdb" ;
4949
5050// Windows
51- const drive = ' \\\\ .\\ PHYSICALDRIVE2' ;
51+ const drive = " \\\\ .\\ PHYSICALDRIVE2" ;
5252
5353mountutils .unmountDisk (drive, (error ) => {
5454 if (error) {
5555 throw error;
5656 }
5757
58- console .log (' Done!' );
58+ console .log (" Done!" );
5959});
6060```
6161
62- Support
63- -------
62+ ## Support
6463
6564If you're having any problem, please [ raise an issue] [ newissue ] on GitHub and
6665the Resin.io team will be happy to help.
6766
68- Tests
69- -----
67+ ## Tests
7068
7169Run the test suite by doing:
7270
7371``` sh
7472$ npm test
7573```
7674
77- Troubleshooting
78- ---------------
75+ ## Troubleshooting
7976
8077### ` error C2373: '__pfnDliNotifyHook2': redefinition `
8178
@@ -88,8 +85,7 @@ npm install -g npm@latest
8885
8986See the [ following ` node-gyp ` issue] ( https://github.com/nodejs/node-gyp/issues/972 ) for more details.
9087
91- Contribute
92- ----------
88+ ## Contribute
9389
9490- Issue Tracker: [ github.com/resin-io-modules/mountutils/issues] [ issues ]
9591- Source Code: [ github.com/resin-io-modules/mountutils] [ source ]
@@ -105,8 +101,7 @@ linters run without any warning:
105101$ npm run lint
106102```
107103
108- License
109- -------
104+ ## License
110105
111106The project is licensed under the Apache 2.0 license.
112107
0 commit comments