Skip to contentpackage
blockdevice
v0.6.1Block Device
node any1 depscjsopen source
- license
- MIT
- deps
- 1
- unpacked
- 19.6 kB
- files
- 7
- node
- any
$npm install blockdevice@0.6.1 README
GitHub-flavored package documentation.
downloads
Across all versions.
Download trend unavailable.
compatibility
Runtime metadata.
keywords
Tagged topics.
fsdeviceblockstoragedrivephysical
versions
Latest published Nov 6, 2018
maintainers
Registry package owners.
install size
Estimated unpacked size across 3 packages.
67.9 kB
Includes dependencies.
dependencies
1 direct dependencies.
contents
- Install via npm
- Usage Examples
- API
- new BlockDevice( options )
- BlockDevice.getPath( id )
- device.open( callback )
- device.close( callback )
- device.detectBlockSize( size, step, limit, callback )
- device.detectSize( step, callback )
- device.partition( options )
- device.getLBA( cylinder, head, sector )
- device.read( offset, length, buffer, callback )
- device.readBlocks( fromLBA, toLBA, buffer, callback )
- device.write( offset, buffer, callback )
- device.writeBlocks( fromLBA, buffer, callback )
- new BlockDevice.Partition( device, options )
- get partition.blockSize -> Number
- get partition.sectors -> Number, number of blocks in partition
- get partition.size -> Number, size in bytes
- partition.OOB( lba )
- partition.readBlocks( from, to, buffer, callback )
- partition.writeBlocks( from, data, callback )
$ npm install --save blockdevice
Usage Examples
API
new BlockDevice( options )
- options: Object
- fs: require( 'fs' ), optional; custom 'fs' instance
- fd: Number, optional; file descriptor
- path: String, optional if
fd is given
- mode: String, optional if
fd is given
- blockSize: Number, optional
- size: Number, optional
- headsPerTrack: Number, optional
- sectorsPerTrack: Number, optional
BlockDevice.getPath( id )
device.open( callback )
- callback: function( err, fd )
device.close( callback )
- callback: function( err )
device.detectBlockSize( size, step, limit, callback )
- size: Number, initial block size to be checked
- step: Number, block size increment
- limit: Number, maximum block size to be checked
- callback: function( err, blockSize )
device.detectSize( step, callback )
- step: Number, size increment
- callback: function( err, size )
device.partition( options )
- options: Object
- firstLBA: Number, first logical block of partition
- lastLBA: Number, last logical block of partition
device.getLBA( cylinder, head, sector )
- cylinder: Number
- head: Number
- sector: Number
device._read( offset, length, buffer, callback )
- offset: Number
- length: Number
- buffer: Buffer, optional
- callback: function( err, buffer, bytesRead )
INTERNAL. Used by .readBlocks().
device.readBlocks( fromLBA, toLBA, buffer, callback )
- fromLBA: Number
- toLBA: Number
- buffer: Buffer, optional
- callback: function( err, buffer, bytesRead )
device._write( offset, buffer, callback )
- offset: Number
- buffer: Buffer
- callback: function( err, bytesWritten )
INTERNAL. Used by .writeBlocks().
device.writeBlocks( fromLBA, buffer, callback )
- fromLBA: Number
- buffer: Buffer
- callback: function( err, bytesWritten )
new BlockDevice.Partition( device, options )
- options: Object
- firstLBA: Number, first logical block of partition
- lastLBA: Number, last logical block of partition
get partition.blockSize -> Number
get partition.sectors -> Number, number of blocks in partition
get partition.size -> Number, size in bytes
partition.__OOB( lba )
- lba: Number, logical block address
INTERNAL. Determines if a given LBA is out of bounds of the partition.
partition.readBlocks( from, to, buffer, callback )
- from: Number
- to: Number
- buffer: Buffer
- callback: function( err, buffer, bytesRead )
partition.writeBlocks( from, data, callback )
- from: Number
- data: Buffer
- callback: function( err, bytesWritten )