binary-file

binary-file

Read and write binary types in files. This library allows you to use the functions you would use on a Buffer, like readUInt32, directly on files. It is promises-based.

npm install --save binary-file

Use case

Say you want to parse a simple binary file for an UInt32 containing the length of the string that follows. With binary-file, you can simply:

'use strict';

const BinaryFile = require('binary-file');

const myBinaryFile = new BinaryFile('./file.bin', 'r');
myBinaryFile.open().then(function () {
  console.log('File opened');
  return myBinaryFile.readUInt32();
}).then(function (stringLength) {
  return myBinaryFile.readString(stringLength);
}).then(function (string) {
  console.log(`File read: ${string}`);
  return myBinaryFile.close();
}).then(function () {
  console.log('File closed');
}).catch(function (err) {
  console.log(`There was an error: ${err}`);
});

And it looks even better with ES7 async / await:

'use strict';

const BinaryFile = require('binary-file');

const myBinaryFile = new BinaryFile('./file.bin', 'r');
(async function () {
  try {
    await myBinaryFile.open();
    console.log('File opened');
    const stringLength = await myBinaryFile.readUInt32();
    const string = await myBinaryFile.readString(stringLength);
    console.log(`File read: ${string}`);
    await myBinaryFile.close();
    console.log('File closed');
  } catch (err) {
    console.log(`There was an error: ${err}`);
  }
})();

You don't have to create a Buffer to write the data read from the file, you don't have to remember the position of the cursor: everything is handled by BinaryFile.

API

File

new BinaryFile(path, mode, littleEndian = false)

Create a new instance of BinaryFile.

• path: the path of the file to open
• mode: the mode in which to open the file. See fs.open
• littleEndian: endianness of the file

.open()

Open the file.

Return a promise.

fulfilled when the file is opened

.size()

Get the size in bytes of the file.

Return a promise.

fulfilled with the size of the file in bytes

.tell()

Get the position of the cursor in the file.

Return the position of the cursor in the file.

.seek(position)

Set the position of the cursor in the file

• position: the position where to place the cursor

Return the new position.

.close()

Close the file.

Return a promise.

fulfilled when the file is closed

Read

.read(length, position = null)

Read a Buffer in the file.

• length: the number of bytes to read
• position: the position where to read the Buffer in the file. If not set, it will use the internal cursor. If set, the internal cursor won't move

Return a promise.

fulfilled with the Buffer when the reading is done

.readInt8(position = null),

.readUInt8(position = null),

.readInt16(position = null),

.readUInt16(position = null),

.readInt32(position = null),

.readUInt32(position = null),

.readInt64(position = null),

.readUInt64(position = null),

.readFloat(position = null),

.readDouble(position = null)

Read a binary type in the file.

• position: the position where to read the binary type in the file. If not set, it will use the internal cursor. If set, the internal cursor won't move

Return a promise.

fulfilled with the value read when the reading is done

.readString(length, position = null)

Read a string in the file.

• length: the number of bytes of the string to read
• position: the position where to read the string in the file. If not set, it will use the internal cursor. If set, the internal cursor won't move

Return a promise.

fulfilled with the string read when the reading is done

Write

.write(buffer, position = null)

Read a Buffer in the file.

• buffer: the Buffer to write
• position: the position where to write the Buffer in the file. If not set, it will use the internal cursor. If set, the internal cursor won't move

Return a promise.

fulfilled with the number of bytes written when the writing is done

.writeInt8(value, position = null),

.writeUInt8(value, position = null),

.writeInt16(value, position = null),

.writeUInt16(value, position = null),

.writeInt32(value, position = null),

.writeUInt32(value, position = null),

.writeInt64(value, position = null),

.writeUInt64(value, position = null),

.writeFloat(value, position = null),

.writeDouble(value, position = null)

Write a binary type in the file.

• value: the value to write in the corresponding binary type
• position: the position where to write the binary type in the file. If not set, it will use the internal cursor. If set, the internal cursor won't move

Return a promise.

fulfilled with the number of bytes written when the writing is done

.writeString(string, position = null)

Write a string in the file.

• string: the string to write
• position: the position where to write the string in the file. If not set, it will use the internal cursor. If set, the internal cursor won't move

Return a promise.

fulfilled with the number of bytes written when the writing is done