Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

partitioninfo

Package Overview
Dependencies
Maintainers
1
Versions
54
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

partitioninfo

Get information about a partition from an image file

  • 4.0.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6.7K
decreased by-5.56%
Maintainers
1
Weekly downloads
 
Created
Source

partitioninfo

Get information about a partition from an image file.

npm version dependencies Build Status Build status ![Gitter](https://badges.gitter.im/Join Chat.svg)

Installation

Install partitioninfo by running:

$ npm install --save partitioninfo

Documentation

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

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

ParamTypeDescription
imageString | filedisk.Diskimage path or filedisk.Disk instance
numberObjectpartition 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: static 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

ParamTypeDefaultDescription
imageString | filedisk.Diskimage path or filedisk.Disk instance
optionsObject
[options.offset]Number0where the first partition table will be read from, in bytes
[options.includeExtended]Booleantruewhether to include extended partitions or not (only for MBR partition tables)
[options.getLogical]Booleantruewhether 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

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

$ npm lint

License

The project is licensed under the MIT license.

Keywords

FAQs

Package last updated on 08 Jun 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc