Skip to content

setCompression

xiao edited this page Nov 8, 2025 · 1 revision

compress or decompress a file or directory on a NTFS Volume.

usage

callback:

fswin.ntfs.setCompression(fileOrDir, callback, [compress], [create]);

async:

var succeeded = await fswin.ntfs.setCompressionAsync(fileOrDir, [compress], [create]);

sync:

var succeeded = fswin.ntfs.setCompressionSync(fileOrDir, [compress], [create]);
  • fileOrDir is a string that specifies a file or directory.
  • callback is a function that takes only one argument succeeded.
  • compress is a boolean value to determine whether to compress or decompress.
  • create is a boolean value to determine whether to create an new file when fileOrDir does not exist.
  • succeeded is a boolean value to indicate whether the operation is succeeded.

example

var fswin = require('fswin');
var fileOrDir = 'd:\\test';

//sync
console.log(fswin.ntfs.setCompressionSync(fileOrDir, true) ? 'succeeded' : 'failed');

//async
console.log(fswin.ntfs.setCompression(fileOrDir, function (succeeded) {
	console.log(succeeded ? 'succeeded' : 'failed');
}, false) ? 'job queued' : 'failed to queue job');

Clone this wiki locally