partitioninfo

partitioninfo

Get information about a partition from an image file.


Installation

Install partitioninfo by running:

$ npm install --save partitioninfo

Documentation

• partitioninfo
  • .get(image, definition) ⇒ Promise.<Object>
  • .getPartitions(image, [offset]) ⇒ Promise.<Array.<Object>>

partitioninfo.get(image, definition) ⇒ Promise.<Object>

Kind: static method of partitioninfo
Summary: Get information from a partition
Returns: Promise.<Object> - partition information
Access: public

Param	Type	Description
image	String | filedisk.Disk	image path or filedisk.Disk instance
definition	Object	partition definition
definition.primary	Number	primary partition
[definition.logical]	Number	logical partition

Example

partitioninfo.get 'foo/bar.img',
	primary: 4
	logical: 1
.then (information) ->
	console.log(information.offset)
	console.log(information.size)
	console.log(information.type)

partitioninfo.getPartitions(image, [offset]) ⇒ Promise.<Array.<Object>>

Kind: static method of partitioninfo
Summary: Read all partition tables from a disk image recursively.
Returns: Promise.<Array.<Object>> - partitions information
Access: public

Param	Type	Default	Description
image	String | filedisk.Disk		image path or filedisk.Disk instance
[offset]	Number	0	where the first partition table will be read from, in bytes

Example

partitioninfo.getPartitions('foo/bar.img')
.then (information) ->
	for partition in information
		console.log(partition.offset)
		console.log(partition.size)
		console.log(partition.type)

Support

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

Tests

Run the test suite by doing:

$ gulp test

Contribute

• Issue Tracker: github.com/resin-io-modules/partitioninfo/issues
• Source Code: github.com/resin-io-modules/partitioninfo

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ gulp lint

License

The project is licensed under the MIT license.