partitioninfo

partitioninfo

Get information about a partition from an image file.


Installation

Install partitioninfo by running:

$ npm install --save partitioninfo

Documentation

• partitioninfo
  • ~get(image, number) ⇒ Promise.<Object>
  • ~getPartitions(image, options) ⇒ Promise.<Object>

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

Kind: inner 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
number	Object	partition number

Example

partitioninfo.get('foo/bar.img', 5)
.then (information) ->
	console.log(information.offset)
	console.log(information.size)
	console.log(information.type)
	console.log(information.index)

partitioninfo~getPartitions(image, options) ⇒ Promise.<Object>

getPartitions() returns an Array. getPartitions(image)[N - 1] may not be equal to get(image, N) For example on a disk with no primary partitions and one extended partition containing a logical one, getPartitions(image) would return an array of 2 partitions (the extended then the logical one), get(image, 1) would return the extended partition and get(image, 5) would return the logical partition. All other numbers would throw an error. Partition numbers for get(image, N) are like Linux's /dev/sdaN.

The array returned by getPartitions() contains primary (or extended) partitions first then the logical ones. This is true even if the extended partition is not the last one of the disk image. Order will always be 1, [2, 3, 4, 5, 6, 7] even if the logical partitions 5, 6 and 7 are physically contained in partiton 1, 2 or 3.

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

• Error if there is no such partition

Access: public

Param	Type	Default	Description
image	String | filedisk.Disk		image path or filedisk.Disk instance
options	Object
[options.offset]	Number	0	where the first partition table will be read from, in bytes
[options.includeExtended]	Boolean	true	whether to include extended partitions or not (only for MBR partition tables)
[options.getLogical]	Boolean	true	whether to include logical partitions or not (only for MBR partition tables)

Example

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

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:

$ npm 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 resin-lint runs without any warning:

$ npm run lint

License

The project is licensed under the MIT license.

Changelog

5.0.0 - 2018-12-21

• Switch to typescript [Alexis Svinartchouk]