Skip to content

Balena image filesystem manipulation utilities.

License

Notifications You must be signed in to change notification settings

balena-io-modules/balena-image-fs

Repository files navigation

balena-image-fs

npm version dependencies Build Status Build status

Balena.io image filesystem manipulation utilities.

Role

The intention of this module is to provide low level utilities to Balena.io operating system data partitions.

THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.

Installation

Install balena-image-fs by running:

$ npm install --save balena-image-fs

Documentation

imagefs~interact()

Kind: inner method of imagefs
Summary: Run a function with a node fs like interface for a partition
Example

const contents = await interact('/foo/bar.img', 5, async (fs) => {
	return await promisify(fs.readFile)('/bar/qux');
});
console.log(contents);

Support

If you're having any problem, please raise an issue on GitHub and the Balena.io team will be happy to help.

Tests

Run the test suite by doing:

$ npm test

Contribute

License

The project is licensed under the Apache 2.0 license.