ext2fs

node-ext2fs

NodeJS native bindings to the linux ext{2,3,4} filesystem library

node-ext2fs uses the e2fsprogs project to provide access to ext filesystem from NodeJS in a cross-platform way.

Some things you can do with this module:

• Read/write files in a filesystem image directly without mounting
• Use familiar APIs, node-ext2fs has the exact same interface as node's fs module
• Combine node-ext2fs filesystem streams with host filesystem streams (e.g copy files)
• Create a tar archive from a filesystem image
• Perform a TRIM operation to obtain discard regions of a filesystem

Warning: The API exposed by this library is still forming and can change at any time!

Installation

To install node-ext2fs you need to have gcc and make available to your environment. For Linux and Mac having a working node-gyp installation is enough. To install on windows, you have to install MingW64 and make sure mingw32-make and gcc are available in your Powershell or cmd.exe terminal.

Simply compile and install node-ext2fs using npm:

$ npm install ext2fs

Example

const ext2fs = require('ext2fs');
const filedisk = require('file-disk');
const fs = require('fs');

const fd = fs.openSync('/path/to/ext4_filesystem.img', 'r+');
const disk = new filedisk.FileDisk(fd);

ext2fs.mount(disk, function(err, filesystem) {
	if (err) {
		return;
	}
	console.log('Mounted filesystem successfully');

	ext2fs.trim(filesystem, function(err) {
		if (err) {
			return;
		}
		console.log('TRIMed filesystem');
		fs.closeSync(fd);
		ext2fs.close();
	});
});

Support

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

License

node-ext2fs is free software, and may be redistributed under the terms specified in the license.