imdisk-wrapper
v2.0.0
Published
A simple wrapper for ImDisk to create (only VM) and delete virtual disks
Downloads
21
Maintainers
Readme
imdisk-wrapper
A simple wrapper for ImDisk to create (only VM) and delete virtual disks.
Install
$ npm i -S imdisk-wrapper
Usage
create(label, size, [options])
imDisk.create('Z', '32M').then((res) => {
console.log(res); // { label: 'Z', size: '32M' }
}).catch((err) => {
console.log(err);
});
arguments:
label
[string
| default: random available letter] - Available drive letter is determined by windows-drive-letters.size
[string
| default:null
] - The size of the disk in the formatnumber[b, k, m, g, t, K, M, G, T]
.
options:
imdiskPath
[string
| default:imdisk
] - A path to ImDisk.fileSystem
[string
| default:ntfs
] - Disk file system.command
[string
| default:null
] - Custom command that replaces the command of creating disk in this module.
remove(label, [options])
imDisk.create('Z').then((res) => {
console.log(res); // { label: 'Z' }
}).catch((err) => {
console.log(err);
});
arguments:
label
[string
| default:null
] - The drive letter to remove.
options:
imdiskPath
[string
| default:imdisk
] - A path to ImDisk.force
[boolean
| default:false
] - Usetrue
to force removal even if the device is in use.command
[string
| default:null
] - Custom command that replaces the command of removing disk in this module.
Changelog
See the Releases section of our GitHub project for changelogs for each release version.
License
This software is released under the terms of the MIT license.